Kowabunga API documentation

Adapter

createAdapter

Creates a new network adapter.


/subnet/{subnetId}/adapter

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/subnet/{subnetId}/adapter?assignIP=true" \
 -d '{
  "addresses" : [ "addresses", "addresses" ],
  "reserved" : false,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "mac" : "mac"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdapterApi;

import java.io.File;
import java.util.*;

public class AdapterApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AdapterApi apiInstance = new AdapterApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.
        Adapter adapter = ; // Adapter | 
        Boolean assignIP = true; // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

        try {
            Adapter result = apiInstance.createAdapter(subnetId, adapter, assignIP);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#createAdapter");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String subnetId = new String(); // String | The ID of the network subnet.
final Adapter adapter = new Adapter(); // Adapter | 
final Boolean assignIP = new Boolean(); // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

try {
    final result = await api_instance.createAdapter(subnetId, adapter, assignIP);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createAdapter: $e\n');
}

import org.openapitools.client.api.AdapterApi;

public class AdapterApiExample {
    public static void main(String[] args) {
        AdapterApi apiInstance = new AdapterApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.
        Adapter adapter = ; // Adapter | 
        Boolean assignIP = true; // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

        try {
            Adapter result = apiInstance.createAdapter(subnetId, adapter, assignIP);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#createAdapter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AdapterApi *apiInstance = [[AdapterApi alloc] init];
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)
Adapter *adapter = ; // 
Boolean *assignIP = true; // Whether Kowabunga should pick and assign an IP address to this adapter. (optional) (default to null)

[apiInstance createAdapterWith:subnetId
    adapter:adapter
    assignIP:assignIP
              completionHandler: ^(Adapter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AdapterApi()
var subnetId = subnetId_example; // {String} The ID of the network subnet.
var adapter = ; // {Adapter} 
var opts = {
  'assignIP': true // {Boolean} Whether Kowabunga should pick and assign an IP address to this adapter.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAdapter(subnetId, adapter, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createAdapterExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AdapterApi();
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)
            var adapter = new Adapter(); // Adapter | 
            var assignIP = true;  // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter. (optional)  (default to null)

            try {
                Adapter result = apiInstance.createAdapter(subnetId, adapter, assignIP);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdapterApi.createAdapter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdapterApi();
$subnetId = subnetId_example; // String | The ID of the network subnet.
$adapter = ; // Adapter | 
$assignIP = true; // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

try {
    $result = $api_instance->createAdapter($subnetId, $adapter, $assignIP);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdapterApi->createAdapter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdapterApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdapterApi->new();
my $subnetId = subnetId_example; # String | The ID of the network subnet.
my $adapter = WWW::OPenAPIClient::Object::Adapter->new(); # Adapter | 
my $assignIP = true; # Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

eval {
    my $result = $api_instance->createAdapter(subnetId => $subnetId, adapter => $adapter, assignIP => $assignIP);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdapterApi->createAdapter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AdapterApi()
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)
adapter =  # Adapter | 
assignIP = true # Boolean | Whether Kowabunga should pick and assign an IP address to this adapter. (optional) (default to null)

try:
    api_response = api_instance.create_adapter(subnetId, adapter, assignIP=assignIP)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdapterApi->createAdapter: %s\n" % e)
extern crate AdapterApi;

pub fn main() {
    let subnetId = subnetId_example; // String
    let adapter = ; // Adapter
    let assignIP = true; // Boolean

    let mut context = AdapterApi::Context::default();
    let result = client.createAdapter(subnetId, adapter, assignIP, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
subnetId*
String
The ID of the network subnet.
Required
Body parameters
Name Description
adapter *

Adapter payload.

Query parameters
Name Description
assignIP
Boolean
Whether Kowabunga should pick and assign an IP address to this adapter.

Responses


deleteAdapter

Deletes an existing network adapter.


/adapter/{adapterId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/adapter/{adapterId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdapterApi;

import java.io.File;
import java.util.*;

public class AdapterApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AdapterApi apiInstance = new AdapterApi();
        String adapterId = adapterId_example; // String | The ID of the network adapter.

        try {
            apiInstance.deleteAdapter(adapterId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#deleteAdapter");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String adapterId = new String(); // String | The ID of the network adapter.

try {
    final result = await api_instance.deleteAdapter(adapterId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteAdapter: $e\n');
}

import org.openapitools.client.api.AdapterApi;

public class AdapterApiExample {
    public static void main(String[] args) {
        AdapterApi apiInstance = new AdapterApi();
        String adapterId = adapterId_example; // String | The ID of the network adapter.

        try {
            apiInstance.deleteAdapter(adapterId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#deleteAdapter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AdapterApi *apiInstance = [[AdapterApi alloc] init];
String *adapterId = adapterId_example; // The ID of the network adapter. (default to null)

[apiInstance deleteAdapterWith:adapterId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AdapterApi()
var adapterId = adapterId_example; // {String} The ID of the network adapter.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAdapter(adapterId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteAdapterExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AdapterApi();
            var adapterId = adapterId_example;  // String | The ID of the network adapter. (default to null)

            try {
                apiInstance.deleteAdapter(adapterId);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdapterApi.deleteAdapter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdapterApi();
$adapterId = adapterId_example; // String | The ID of the network adapter.

try {
    $api_instance->deleteAdapter($adapterId);
} catch (Exception $e) {
    echo 'Exception when calling AdapterApi->deleteAdapter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdapterApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdapterApi->new();
my $adapterId = adapterId_example; # String | The ID of the network adapter.

eval {
    $api_instance->deleteAdapter(adapterId => $adapterId);
};
if ($@) {
    warn "Exception when calling AdapterApi->deleteAdapter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AdapterApi()
adapterId = adapterId_example # String | The ID of the network adapter. (default to null)

try:
    api_instance.delete_adapter(adapterId)
except ApiException as e:
    print("Exception when calling AdapterApi->deleteAdapter: %s\n" % e)
extern crate AdapterApi;

pub fn main() {
    let adapterId = adapterId_example; // String

    let mut context = AdapterApi::Context::default();
    let result = client.deleteAdapter(adapterId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
adapterId*
String
The ID of the network adapter.
Required

Responses


listAdapters

Returns the IDs of network adapter objects.


/adapter

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/adapter"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdapterApi;

import java.io.File;
import java.util.*;

public class AdapterApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AdapterApi apiInstance = new AdapterApi();

        try {
            array['String'] result = apiInstance.listAdapters();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#listAdapters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listAdapters();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listAdapters: $e\n');
}

import org.openapitools.client.api.AdapterApi;

public class AdapterApiExample {
    public static void main(String[] args) {
        AdapterApi apiInstance = new AdapterApi();

        try {
            array['String'] result = apiInstance.listAdapters();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#listAdapters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AdapterApi *apiInstance = [[AdapterApi alloc] init];

[apiInstance listAdaptersWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AdapterApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAdapters(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listAdaptersExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AdapterApi();

            try {
                array['String'] result = apiInstance.listAdapters();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdapterApi.listAdapters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdapterApi();

try {
    $result = $api_instance->listAdapters();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdapterApi->listAdapters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdapterApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdapterApi->new();

eval {
    my $result = $api_instance->listAdapters();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdapterApi->listAdapters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AdapterApi()

try:
    api_response = api_instance.list_adapters()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdapterApi->listAdapters: %s\n" % e)
extern crate AdapterApi;

pub fn main() {

    let mut context = AdapterApi::Context::default();
    let result = client.listAdapters(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listSubnetAdapters

Returns the IDs of network adapter objects.


/subnet/{subnetId}/adapters

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/subnet/{subnetId}/adapters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdapterApi;

import java.io.File;
import java.util.*;

public class AdapterApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AdapterApi apiInstance = new AdapterApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            array['String'] result = apiInstance.listSubnetAdapters(subnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#listSubnetAdapters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String subnetId = new String(); // String | The ID of the network subnet.

try {
    final result = await api_instance.listSubnetAdapters(subnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listSubnetAdapters: $e\n');
}

import org.openapitools.client.api.AdapterApi;

public class AdapterApiExample {
    public static void main(String[] args) {
        AdapterApi apiInstance = new AdapterApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            array['String'] result = apiInstance.listSubnetAdapters(subnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#listSubnetAdapters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AdapterApi *apiInstance = [[AdapterApi alloc] init];
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)

[apiInstance listSubnetAdaptersWith:subnetId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AdapterApi()
var subnetId = subnetId_example; // {String} The ID of the network subnet.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubnetAdapters(subnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listSubnetAdaptersExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AdapterApi();
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)

            try {
                array['String'] result = apiInstance.listSubnetAdapters(subnetId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdapterApi.listSubnetAdapters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdapterApi();
$subnetId = subnetId_example; // String | The ID of the network subnet.

try {
    $result = $api_instance->listSubnetAdapters($subnetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdapterApi->listSubnetAdapters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdapterApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdapterApi->new();
my $subnetId = subnetId_example; # String | The ID of the network subnet.

eval {
    my $result = $api_instance->listSubnetAdapters(subnetId => $subnetId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdapterApi->listSubnetAdapters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AdapterApi()
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)

try:
    api_response = api_instance.list_subnet_adapters(subnetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdapterApi->listSubnetAdapters: %s\n" % e)
extern crate AdapterApi;

pub fn main() {
    let subnetId = subnetId_example; // String

    let mut context = AdapterApi::Context::default();
    let result = client.listSubnetAdapters(subnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
subnetId*
String
The ID of the network subnet.
Required

Responses


readAdapter

Returns a network adapter.


/adapter/{adapterId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/adapter/{adapterId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdapterApi;

import java.io.File;
import java.util.*;

public class AdapterApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AdapterApi apiInstance = new AdapterApi();
        String adapterId = adapterId_example; // String | The ID of the network adapter.

        try {
            Adapter result = apiInstance.readAdapter(adapterId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#readAdapter");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String adapterId = new String(); // String | The ID of the network adapter.

try {
    final result = await api_instance.readAdapter(adapterId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readAdapter: $e\n');
}

import org.openapitools.client.api.AdapterApi;

public class AdapterApiExample {
    public static void main(String[] args) {
        AdapterApi apiInstance = new AdapterApi();
        String adapterId = adapterId_example; // String | The ID of the network adapter.

        try {
            Adapter result = apiInstance.readAdapter(adapterId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#readAdapter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AdapterApi *apiInstance = [[AdapterApi alloc] init];
String *adapterId = adapterId_example; // The ID of the network adapter. (default to null)

[apiInstance readAdapterWith:adapterId
              completionHandler: ^(Adapter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AdapterApi()
var adapterId = adapterId_example; // {String} The ID of the network adapter.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readAdapter(adapterId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readAdapterExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AdapterApi();
            var adapterId = adapterId_example;  // String | The ID of the network adapter. (default to null)

            try {
                Adapter result = apiInstance.readAdapter(adapterId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdapterApi.readAdapter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdapterApi();
$adapterId = adapterId_example; // String | The ID of the network adapter.

try {
    $result = $api_instance->readAdapter($adapterId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdapterApi->readAdapter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdapterApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdapterApi->new();
my $adapterId = adapterId_example; # String | The ID of the network adapter.

eval {
    my $result = $api_instance->readAdapter(adapterId => $adapterId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdapterApi->readAdapter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AdapterApi()
adapterId = adapterId_example # String | The ID of the network adapter. (default to null)

try:
    api_response = api_instance.read_adapter(adapterId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdapterApi->readAdapter: %s\n" % e)
extern crate AdapterApi;

pub fn main() {
    let adapterId = adapterId_example; // String

    let mut context = AdapterApi::Context::default();
    let result = client.readAdapter(adapterId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
adapterId*
String
The ID of the network adapter.
Required

Responses


updateAdapter

Updates a network adapter configuration.


/adapter/{adapterId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/adapter/{adapterId}" \
 -d '{
  "addresses" : [ "addresses", "addresses" ],
  "reserved" : false,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "mac" : "mac"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AdapterApi;

import java.io.File;
import java.util.*;

public class AdapterApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AdapterApi apiInstance = new AdapterApi();
        String adapterId = adapterId_example; // String | The ID of the network adapter.
        Adapter adapter = ; // Adapter | 

        try {
            Adapter result = apiInstance.updateAdapter(adapterId, adapter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#updateAdapter");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String adapterId = new String(); // String | The ID of the network adapter.
final Adapter adapter = new Adapter(); // Adapter | 

try {
    final result = await api_instance.updateAdapter(adapterId, adapter);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateAdapter: $e\n');
}

import org.openapitools.client.api.AdapterApi;

public class AdapterApiExample {
    public static void main(String[] args) {
        AdapterApi apiInstance = new AdapterApi();
        String adapterId = adapterId_example; // String | The ID of the network adapter.
        Adapter adapter = ; // Adapter | 

        try {
            Adapter result = apiInstance.updateAdapter(adapterId, adapter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdapterApi#updateAdapter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AdapterApi *apiInstance = [[AdapterApi alloc] init];
String *adapterId = adapterId_example; // The ID of the network adapter. (default to null)
Adapter *adapter = ; // 

[apiInstance updateAdapterWith:adapterId
    adapter:adapter
              completionHandler: ^(Adapter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AdapterApi()
var adapterId = adapterId_example; // {String} The ID of the network adapter.
var adapter = ; // {Adapter} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAdapter(adapterId, adapter, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateAdapterExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AdapterApi();
            var adapterId = adapterId_example;  // String | The ID of the network adapter. (default to null)
            var adapter = new Adapter(); // Adapter | 

            try {
                Adapter result = apiInstance.updateAdapter(adapterId, adapter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AdapterApi.updateAdapter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AdapterApi();
$adapterId = adapterId_example; // String | The ID of the network adapter.
$adapter = ; // Adapter | 

try {
    $result = $api_instance->updateAdapter($adapterId, $adapter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdapterApi->updateAdapter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AdapterApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AdapterApi->new();
my $adapterId = adapterId_example; # String | The ID of the network adapter.
my $adapter = WWW::OPenAPIClient::Object::Adapter->new(); # Adapter | 

eval {
    my $result = $api_instance->updateAdapter(adapterId => $adapterId, adapter => $adapter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdapterApi->updateAdapter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AdapterApi()
adapterId = adapterId_example # String | The ID of the network adapter. (default to null)
adapter =  # Adapter | 

try:
    api_response = api_instance.update_adapter(adapterId, adapter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdapterApi->updateAdapter: %s\n" % e)
extern crate AdapterApi;

pub fn main() {
    let adapterId = adapterId_example; // String
    let adapter = ; // Adapter

    let mut context = AdapterApi::Context::default();
    let result = client.updateAdapter(adapterId, adapter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
adapterId*
String
The ID of the network adapter.
Required
Body parameters
Name Description
adapter *

Adapter payload.

Responses


Agent

createAgent

Creates a new Kowabunga remote agent.


/agent

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/agent" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "type" : "Kiwi"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

import java.io.File;
import java.util.*;

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        Agent agent = ; // Agent | 

        try {
            Agent result = apiInstance.createAgent(agent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#createAgent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Agent agent = new Agent(); // Agent | 

try {
    final result = await api_instance.createAgent(agent);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createAgent: $e\n');
}

import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        Agent agent = ; // Agent | 

        try {
            Agent result = apiInstance.createAgent(agent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#createAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
Agent *agent = ; // 

[apiInstance createAgentWith:agent
              completionHandler: ^(Agent output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AgentApi()
var agent = ; // {Agent} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAgent(agent, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createAgentExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agent = new Agent(); // Agent | 

            try {
                Agent result = apiInstance.createAgent(agent);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.createAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agent = ; // Agent | 

try {
    $result = $api_instance->createAgent($agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->createAgent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agent = WWW::OPenAPIClient::Object::Agent->new(); # Agent | 

eval {
    my $result = $api_instance->createAgent(agent => $agent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->createAgent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agent =  # Agent | 

try:
    api_response = api_instance.create_agent(agent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->createAgent: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agent = ; // Agent

    let mut context = AgentApi::Context::default();
    let result = client.createAgent(agent, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
agent *

Agent payload.

Responses


deleteAgent

Deletes an existing Kowabunga remote agent.


/agent/{agentId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/agent/{agentId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

import java.io.File;
import java.util.*;

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.

        try {
            apiInstance.deleteAgent(agentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#deleteAgent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String agentId = new String(); // String | The ID of the Kowabunga remote agent.

try {
    final result = await api_instance.deleteAgent(agentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteAgent: $e\n');
}

import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.

        try {
            apiInstance.deleteAgent(agentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#deleteAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
String *agentId = agentId_example; // The ID of the Kowabunga remote agent. (default to null)

[apiInstance deleteAgentWith:agentId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AgentApi()
var agentId = agentId_example; // {String} The ID of the Kowabunga remote agent.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAgent(agentId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteAgentExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = agentId_example;  // String | The ID of the Kowabunga remote agent. (default to null)

            try {
                apiInstance.deleteAgent(agentId);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.deleteAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = agentId_example; // String | The ID of the Kowabunga remote agent.

try {
    $api_instance->deleteAgent($agentId);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->deleteAgent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = agentId_example; # String | The ID of the Kowabunga remote agent.

eval {
    $api_instance->deleteAgent(agentId => $agentId);
};
if ($@) {
    warn "Exception when calling AgentApi->deleteAgent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = agentId_example # String | The ID of the Kowabunga remote agent. (default to null)

try:
    api_instance.delete_agent(agentId)
except ApiException as e:
    print("Exception when calling AgentApi->deleteAgent: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = agentId_example; // String

    let mut context = AgentApi::Context::default();
    let result = client.deleteAgent(agentId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agentId*
String
The ID of the Kowabunga remote agent.
Required

Responses


listAgents

Returns the IDs of Kowabunga remote agent objects.


/agent

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/agent"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

import java.io.File;
import java.util.*;

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();

        try {
            array['String'] result = apiInstance.listAgents();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#listAgents");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listAgents();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listAgents: $e\n');
}

import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();

        try {
            array['String'] result = apiInstance.listAgents();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#listAgents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];

[apiInstance listAgentsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AgentApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAgents(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listAgentsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();

            try {
                array['String'] result = apiInstance.listAgents();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.listAgents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();

try {
    $result = $api_instance->listAgents();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->listAgents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();

eval {
    my $result = $api_instance->listAgents();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->listAgents: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()

try:
    api_response = api_instance.list_agents()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->listAgents: %s\n" % e)
extern crate AgentApi;

pub fn main() {

    let mut context = AgentApi::Context::default();
    let result = client.listAgents(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readAgent

Returns a Kowabunga remote agent.


/agent/{agentId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/agent/{agentId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

import java.io.File;
import java.util.*;

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.

        try {
            Agent result = apiInstance.readAgent(agentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#readAgent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String agentId = new String(); // String | The ID of the Kowabunga remote agent.

try {
    final result = await api_instance.readAgent(agentId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readAgent: $e\n');
}

import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.

        try {
            Agent result = apiInstance.readAgent(agentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#readAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
String *agentId = agentId_example; // The ID of the Kowabunga remote agent. (default to null)

[apiInstance readAgentWith:agentId
              completionHandler: ^(Agent output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AgentApi()
var agentId = agentId_example; // {String} The ID of the Kowabunga remote agent.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readAgent(agentId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readAgentExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = agentId_example;  // String | The ID of the Kowabunga remote agent. (default to null)

            try {
                Agent result = apiInstance.readAgent(agentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.readAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = agentId_example; // String | The ID of the Kowabunga remote agent.

try {
    $result = $api_instance->readAgent($agentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->readAgent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = agentId_example; # String | The ID of the Kowabunga remote agent.

eval {
    my $result = $api_instance->readAgent(agentId => $agentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->readAgent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = agentId_example # String | The ID of the Kowabunga remote agent. (default to null)

try:
    api_response = api_instance.read_agent(agentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->readAgent: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = agentId_example; // String

    let mut context = AgentApi::Context::default();
    let result = client.readAgent(agentId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agentId*
String
The ID of the Kowabunga remote agent.
Required

Responses


setAgentApiToken

Performs a Kowabunga remote agent setting of API token (will replace any existing one).


/agent/{agentId}/token

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/agent/{agentId}/token?expire=true&expiration_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

import java.io.File;
import java.util.*;

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
        Boolean expire = true; // Boolean | Whether or not the token should expire.
        date expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

        try {
            ApiToken result = apiInstance.setAgentApiToken(agentId, expire, expirationDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#setAgentApiToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String agentId = new String(); // String | The ID of the Kowabunga remote agent.
final Boolean expire = new Boolean(); // Boolean | Whether or not the token should expire.
final date expirationDate = new date(); // date | Token's expiration date (YYYY-MM-DD format).

try {
    final result = await api_instance.setAgentApiToken(agentId, expire, expirationDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setAgentApiToken: $e\n');
}

import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
        Boolean expire = true; // Boolean | Whether or not the token should expire.
        date expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

        try {
            ApiToken result = apiInstance.setAgentApiToken(agentId, expire, expirationDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#setAgentApiToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
String *agentId = agentId_example; // The ID of the Kowabunga remote agent. (default to null)
Boolean *expire = true; // Whether or not the token should expire. (optional) (default to null)
date *expirationDate = 2013-10-20; // Token's expiration date (YYYY-MM-DD format). (optional) (default to null)

[apiInstance setAgentApiTokenWith:agentId
    expire:expire
    expirationDate:expirationDate
              completionHandler: ^(ApiToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AgentApi()
var agentId = agentId_example; // {String} The ID of the Kowabunga remote agent.
var opts = {
  'expire': true, // {Boolean} Whether or not the token should expire.
  'expirationDate': 2013-10-20 // {date} Token's expiration date (YYYY-MM-DD format).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setAgentApiToken(agentId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setAgentApiTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = agentId_example;  // String | The ID of the Kowabunga remote agent. (default to null)
            var expire = true;  // Boolean | Whether or not the token should expire. (optional)  (default to null)
            var expirationDate = 2013-10-20;  // date | Token's expiration date (YYYY-MM-DD format). (optional)  (default to null)

            try {
                ApiToken result = apiInstance.setAgentApiToken(agentId, expire, expirationDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.setAgentApiToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
$expire = true; // Boolean | Whether or not the token should expire.
$expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

try {
    $result = $api_instance->setAgentApiToken($agentId, $expire, $expirationDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->setAgentApiToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = agentId_example; # String | The ID of the Kowabunga remote agent.
my $expire = true; # Boolean | Whether or not the token should expire.
my $expirationDate = 2013-10-20; # date | Token's expiration date (YYYY-MM-DD format).

eval {
    my $result = $api_instance->setAgentApiToken(agentId => $agentId, expire => $expire, expirationDate => $expirationDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->setAgentApiToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = agentId_example # String | The ID of the Kowabunga remote agent. (default to null)
expire = true # Boolean | Whether or not the token should expire. (optional) (default to null)
expirationDate = 2013-10-20 # date | Token's expiration date (YYYY-MM-DD format). (optional) (default to null)

try:
    api_response = api_instance.set_agent_api_token(agentId, expire=expire, expirationDate=expirationDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->setAgentApiToken: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = agentId_example; // String
    let expire = true; // Boolean
    let expirationDate = 2013-10-20; // date

    let mut context = AgentApi::Context::default();
    let result = client.setAgentApiToken(agentId, expire, expirationDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agentId*
String
The ID of the Kowabunga remote agent.
Required
Query parameters
Name Description
expire
Boolean
Whether or not the token should expire.
expiration_date
date (date)
Token's expiration date (YYYY-MM-DD format).

Responses


updateAgent

Updates a Kowabunga remote agent configuration.


/agent/{agentId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/agent/{agentId}" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "type" : "Kiwi"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AgentApi;

import java.io.File;
import java.util.*;

public class AgentApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        AgentApi apiInstance = new AgentApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
        Agent agent = ; // Agent | 

        try {
            Agent result = apiInstance.updateAgent(agentId, agent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#updateAgent");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String agentId = new String(); // String | The ID of the Kowabunga remote agent.
final Agent agent = new Agent(); // Agent | 

try {
    final result = await api_instance.updateAgent(agentId, agent);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateAgent: $e\n');
}

import org.openapitools.client.api.AgentApi;

public class AgentApiExample {
    public static void main(String[] args) {
        AgentApi apiInstance = new AgentApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
        Agent agent = ; // Agent | 

        try {
            Agent result = apiInstance.updateAgent(agentId, agent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentApi#updateAgent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AgentApi *apiInstance = [[AgentApi alloc] init];
String *agentId = agentId_example; // The ID of the Kowabunga remote agent. (default to null)
Agent *agent = ; // 

[apiInstance updateAgentWith:agentId
    agent:agent
              completionHandler: ^(Agent output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.AgentApi()
var agentId = agentId_example; // {String} The ID of the Kowabunga remote agent.
var agent = ; // {Agent} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAgent(agentId, agent, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateAgentExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new AgentApi();
            var agentId = agentId_example;  // String | The ID of the Kowabunga remote agent. (default to null)
            var agent = new Agent(); // Agent | 

            try {
                Agent result = apiInstance.updateAgent(agentId, agent);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AgentApi.updateAgent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AgentApi();
$agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
$agent = ; // Agent | 

try {
    $result = $api_instance->updateAgent($agentId, $agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentApi->updateAgent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AgentApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AgentApi->new();
my $agentId = agentId_example; # String | The ID of the Kowabunga remote agent.
my $agent = WWW::OPenAPIClient::Object::Agent->new(); # Agent | 

eval {
    my $result = $api_instance->updateAgent(agentId => $agentId, agent => $agent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentApi->updateAgent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AgentApi()
agentId = agentId_example # String | The ID of the Kowabunga remote agent. (default to null)
agent =  # Agent | 

try:
    api_response = api_instance.update_agent(agentId, agent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentApi->updateAgent: %s\n" % e)
extern crate AgentApi;

pub fn main() {
    let agentId = agentId_example; // String
    let agent = ; // Agent

    let mut context = AgentApi::Context::default();
    let result = client.updateAgent(agentId, agent, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agentId*
String
The ID of the Kowabunga remote agent.
Required
Body parameters
Name Description
agent *

Agent payload.

Responses


Instance

createProjectZoneInstance

Creates a new virtual machine instance.


/project/{projectId}/zone/{zoneId}/instance

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/instance" \
 -d '{
  "memory" : 0,
  "adapters" : [ "adapters", "adapters" ],
  "name" : "name",
  "volumes" : [ "volumes", "volumes" ],
  "description" : "description",
  "id" : "id",
  "vcpus" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Instance instance = ; // Instance | 

        try {
            Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#createProjectZoneInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Instance instance = new Instance(); // Instance | 

try {
    final result = await api_instance.createProjectZoneInstance(projectId, zoneId, instance);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Instance instance = ; // Instance | 

        try {
            Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#createProjectZoneInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Instance *instance = ; // 

[apiInstance createProjectZoneInstanceWith:projectId
    zoneId:zoneId
    instance:instance
              completionHandler: ^(Instance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var instance = ; // {Instance} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneInstance(projectId, zoneId, instance, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var instance = new Instance(); // Instance | 

            try {
                Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.createProjectZoneInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$instance = ; // Instance | 

try {
    $result = $api_instance->createProjectZoneInstance($projectId, $zoneId, $instance);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->createProjectZoneInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $instance = WWW::OPenAPIClient::Object::Instance->new(); # Instance | 

eval {
    my $result = $api_instance->createProjectZoneInstance(projectId => $projectId, zoneId => $zoneId, instance => $instance);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstanceApi->createProjectZoneInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
instance =  # Instance | 

try:
    api_response = api_instance.create_project_zone_instance(projectId, zoneId, instance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceApi->createProjectZoneInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let instance = ; // Instance

    let mut context = InstanceApi::Context::default();
    let result = client.createProjectZoneInstance(projectId, zoneId, instance, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
instance *

Instance payload.

Responses


deleteInstance

Deletes an existing virtual machine instance.


/instance/{instanceId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.deleteInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#deleteInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.deleteInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.deleteInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#deleteInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance deleteInstanceWith:instanceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                apiInstance.deleteInstance(instanceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.deleteInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $api_instance->deleteInstance($instanceId);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->deleteInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    $api_instance->deleteInstance(instanceId => $instanceId);
};
if ($@) {
    warn "Exception when calling InstanceApi->deleteInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_instance.delete_instance(instanceId)
except ApiException as e:
    print("Exception when calling InstanceApi->deleteInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.deleteInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


listInstances

Returns the IDs of virtual machine instance objects.


/instance

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();

        try {
            array['String'] result = apiInstance.listInstances();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#listInstances");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listInstances();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listInstances: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();

        try {
            array['String'] result = apiInstance.listInstances();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#listInstances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];

[apiInstance listInstancesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listInstances(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listInstancesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();

            try {
                array['String'] result = apiInstance.listInstances();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.listInstances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();

try {
    $result = $api_instance->listInstances();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->listInstances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();

eval {
    my $result = $api_instance->listInstances();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstanceApi->listInstances: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()

try:
    api_response = api_instance.list_instances()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceApi->listInstances: %s\n" % e)
extern crate InstanceApi;

pub fn main() {

    let mut context = InstanceApi::Context::default();
    let result = client.listInstances(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listKaktusInstances

Returns the IDs of virtual machine instance objects.


/kaktus/{kaktusId}/instances

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kaktus/{kaktusId}/instances"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            array['String'] result = apiInstance.listKaktusInstances(kaktusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#listKaktusInstances");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kaktusId = new String(); // String | The ID of the Kaktus computing node.

try {
    final result = await api_instance.listKaktusInstances(kaktusId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKaktusInstances: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            array['String'] result = apiInstance.listKaktusInstances(kaktusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#listKaktusInstances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *kaktusId = kaktusId_example; // The ID of the Kaktus computing node. (default to null)

[apiInstance listKaktusInstancesWith:kaktusId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var kaktusId = kaktusId_example; // {String} The ID of the Kaktus computing node.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKaktusInstances(kaktusId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKaktusInstancesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var kaktusId = kaktusId_example;  // String | The ID of the Kaktus computing node. (default to null)

            try {
                array['String'] result = apiInstance.listKaktusInstances(kaktusId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.listKaktusInstances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

try {
    $result = $api_instance->listKaktusInstances($kaktusId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->listKaktusInstances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $kaktusId = kaktusId_example; # String | The ID of the Kaktus computing node.

eval {
    my $result = $api_instance->listKaktusInstances(kaktusId => $kaktusId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstanceApi->listKaktusInstances: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
kaktusId = kaktusId_example # String | The ID of the Kaktus computing node. (default to null)

try:
    api_response = api_instance.list_kaktus_instances(kaktusId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceApi->listKaktusInstances: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let kaktusId = kaktusId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.listKaktusInstances(kaktusId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kaktusId*
String
The ID of the Kaktus computing node.
Required

Responses


listProjectZoneInstances

Returns the IDs of virtual machine instance objects.


/project/{projectId}/zone/{zoneId}/instances

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/instances"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#listProjectZoneInstances");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneInstances(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneInstances: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#listProjectZoneInstances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneInstancesWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneInstances(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneInstancesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.listProjectZoneInstances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneInstances($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->listProjectZoneInstances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneInstances(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstanceApi->listProjectZoneInstances: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_instances(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceApi->listProjectZoneInstances: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.listProjectZoneInstances(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


readInstance

Returns a virtual machine instance.


/instance/{instanceId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            Instance result = apiInstance.readInstance(instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#readInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.readInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            Instance result = apiInstance.readInstance(instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#readInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance readInstanceWith:instanceId
              completionHandler: ^(Instance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                Instance result = apiInstance.readInstance(instanceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.readInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $result = $api_instance->readInstance($instanceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->readInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    my $result = $api_instance->readInstance(instanceId => $instanceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstanceApi->readInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_response = api_instance.read_instance(instanceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceApi->readInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.readInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


readInstanceRemoteConnection

Returns a virtual machine instance remote access characteristics.


/instance/{instanceId}/connect

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/connect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            InstanceRemoteAccess result = apiInstance.readInstanceRemoteConnection(instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#readInstanceRemoteConnection");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.readInstanceRemoteConnection(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readInstanceRemoteConnection: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            InstanceRemoteAccess result = apiInstance.readInstanceRemoteConnection(instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#readInstanceRemoteConnection");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance readInstanceRemoteConnectionWith:instanceId
              completionHandler: ^(InstanceRemoteAccess output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readInstanceRemoteConnection(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readInstanceRemoteConnectionExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                InstanceRemoteAccess result = apiInstance.readInstanceRemoteConnection(instanceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.readInstanceRemoteConnection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $result = $api_instance->readInstanceRemoteConnection($instanceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->readInstanceRemoteConnection: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    my $result = $api_instance->readInstanceRemoteConnection(instanceId => $instanceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstanceApi->readInstanceRemoteConnection: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_response = api_instance.read_instance_remote_connection(instanceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceApi->readInstanceRemoteConnection: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.readInstanceRemoteConnection(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


readInstanceState

Returns a virtual machine instance state.


/instance/{instanceId}/state

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/state"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            InstanceState result = apiInstance.readInstanceState(instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#readInstanceState");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.readInstanceState(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readInstanceState: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            InstanceState result = apiInstance.readInstanceState(instanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#readInstanceState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance readInstanceStateWith:instanceId
              completionHandler: ^(InstanceState output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readInstanceState(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readInstanceStateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                InstanceState result = apiInstance.readInstanceState(instanceId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.readInstanceState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $result = $api_instance->readInstanceState($instanceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->readInstanceState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    my $result = $api_instance->readInstanceState(instanceId => $instanceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstanceApi->readInstanceState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_response = api_instance.read_instance_state(instanceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceApi->readInstanceState: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.readInstanceState(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


rebootInstance

Performs a virtual machine instance software reboot.


/instance/{instanceId}/reboot

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/reboot"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.rebootInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#rebootInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.rebootInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->rebootInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.rebootInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#rebootInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance rebootInstanceWith:instanceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.rebootInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class rebootInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                apiInstance.rebootInstance(instanceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.rebootInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $api_instance->rebootInstance($instanceId);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->rebootInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    $api_instance->rebootInstance(instanceId => $instanceId);
};
if ($@) {
    warn "Exception when calling InstanceApi->rebootInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_instance.reboot_instance(instanceId)
except ApiException as e:
    print("Exception when calling InstanceApi->rebootInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.rebootInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


resetInstance

Performs a virtual machine instance hardware reset.


/instance/{instanceId}/reset

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.resetInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#resetInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.resetInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resetInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.resetInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#resetInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance resetInstanceWith:instanceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class resetInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                apiInstance.resetInstance(instanceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.resetInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $api_instance->resetInstance($instanceId);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->resetInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    $api_instance->resetInstance(instanceId => $instanceId);
};
if ($@) {
    warn "Exception when calling InstanceApi->resetInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_instance.reset_instance(instanceId)
except ApiException as e:
    print("Exception when calling InstanceApi->resetInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.resetInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


resumeInstance

Performs a virtual machine instance software PM resume.


/instance/{instanceId}/resume

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/resume"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.resumeInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#resumeInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.resumeInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resumeInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.resumeInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#resumeInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance resumeInstanceWith:instanceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resumeInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class resumeInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                apiInstance.resumeInstance(instanceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.resumeInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $api_instance->resumeInstance($instanceId);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->resumeInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    $api_instance->resumeInstance(instanceId => $instanceId);
};
if ($@) {
    warn "Exception when calling InstanceApi->resumeInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_instance.resume_instance(instanceId)
except ApiException as e:
    print("Exception when calling InstanceApi->resumeInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.resumeInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


shutdownInstance

Performs a virtual machine instance software shutdown.


/instance/{instanceId}/shutdown

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/shutdown"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.shutdownInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#shutdownInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.shutdownInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->shutdownInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.shutdownInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#shutdownInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance shutdownInstanceWith:instanceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.shutdownInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class shutdownInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                apiInstance.shutdownInstance(instanceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.shutdownInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $api_instance->shutdownInstance($instanceId);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->shutdownInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    $api_instance->shutdownInstance(instanceId => $instanceId);
};
if ($@) {
    warn "Exception when calling InstanceApi->shutdownInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_instance.shutdown_instance(instanceId)
except ApiException as e:
    print("Exception when calling InstanceApi->shutdownInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.shutdownInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


startInstance

Performs a virtual machine instance hardware boot-up.


/instance/{instanceId}/start

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/start"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.startInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#startInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.startInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->startInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.startInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#startInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance startInstanceWith:instanceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.startInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class startInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                apiInstance.startInstance(instanceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.startInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $api_instance->startInstance($instanceId);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->startInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    $api_instance->startInstance(instanceId => $instanceId);
};
if ($@) {
    warn "Exception when calling InstanceApi->startInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_instance.start_instance(instanceId)
except ApiException as e:
    print("Exception when calling InstanceApi->startInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.startInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


stopInstance

Performs a virtual machine instance hardware stop.


/instance/{instanceId}/stop

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/stop"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.stopInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#stopInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.stopInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->stopInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.stopInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#stopInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance stopInstanceWith:instanceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.stopInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class stopInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                apiInstance.stopInstance(instanceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.stopInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $api_instance->stopInstance($instanceId);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->stopInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    $api_instance->stopInstance(instanceId => $instanceId);
};
if ($@) {
    warn "Exception when calling InstanceApi->stopInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_instance.stop_instance(instanceId)
except ApiException as e:
    print("Exception when calling InstanceApi->stopInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.stopInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


suspendInstance

Performs a virtual machine instance software PM suspend.


/instance/{instanceId}/suspend

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/instance/{instanceId}/suspend"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.suspendInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#suspendInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.

try {
    final result = await api_instance.suspendInstance(instanceId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->suspendInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.

        try {
            apiInstance.suspendInstance(instanceId);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#suspendInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)

[apiInstance suspendInstanceWith:instanceId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.suspendInstance(instanceId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class suspendInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)

            try {
                apiInstance.suspendInstance(instanceId);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.suspendInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.

try {
    $api_instance->suspendInstance($instanceId);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->suspendInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.

eval {
    $api_instance->suspendInstance(instanceId => $instanceId);
};
if ($@) {
    warn "Exception when calling InstanceApi->suspendInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)

try:
    api_instance.suspend_instance(instanceId)
except ApiException as e:
    print("Exception when calling InstanceApi->suspendInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String

    let mut context = InstanceApi::Context::default();
    let result = client.suspendInstance(instanceId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required

Responses


updateInstance

Updates a virtual machine instance configuration.


/instance/{instanceId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/instance/{instanceId}" \
 -d '{
  "memory" : 0,
  "adapters" : [ "adapters", "adapters" ],
  "name" : "name",
  "volumes" : [ "volumes", "volumes" ],
  "description" : "description",
  "id" : "id",
  "vcpus" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.InstanceApi;

import java.io.File;
import java.util.*;

public class InstanceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.
        Instance instance = ; // Instance | 

        try {
            Instance result = apiInstance.updateInstance(instanceId, instance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#updateInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String instanceId = new String(); // String | The ID of the virtual machine instance.
final Instance instance = new Instance(); // Instance | 

try {
    final result = await api_instance.updateInstance(instanceId, instance);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateInstance: $e\n');
}

import org.openapitools.client.api.InstanceApi;

public class InstanceApiExample {
    public static void main(String[] args) {
        InstanceApi apiInstance = new InstanceApi();
        String instanceId = instanceId_example; // String | The ID of the virtual machine instance.
        Instance instance = ; // Instance | 

        try {
            Instance result = apiInstance.updateInstance(instanceId, instance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InstanceApi#updateInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
InstanceApi *apiInstance = [[InstanceApi alloc] init];
String *instanceId = instanceId_example; // The ID of the virtual machine instance. (default to null)
Instance *instance = ; // 

[apiInstance updateInstanceWith:instanceId
    instance:instance
              completionHandler: ^(Instance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.InstanceApi()
var instanceId = instanceId_example; // {String} The ID of the virtual machine instance.
var instance = ; // {Instance} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateInstance(instanceId, instance, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new InstanceApi();
            var instanceId = instanceId_example;  // String | The ID of the virtual machine instance. (default to null)
            var instance = new Instance(); // Instance | 

            try {
                Instance result = apiInstance.updateInstance(instanceId, instance);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling InstanceApi.updateInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\InstanceApi();
$instanceId = instanceId_example; // String | The ID of the virtual machine instance.
$instance = ; // Instance | 

try {
    $result = $api_instance->updateInstance($instanceId, $instance);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InstanceApi->updateInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::InstanceApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::InstanceApi->new();
my $instanceId = instanceId_example; # String | The ID of the virtual machine instance.
my $instance = WWW::OPenAPIClient::Object::Instance->new(); # Instance | 

eval {
    my $result = $api_instance->updateInstance(instanceId => $instanceId, instance => $instance);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InstanceApi->updateInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.InstanceApi()
instanceId = instanceId_example # String | The ID of the virtual machine instance. (default to null)
instance =  # Instance | 

try:
    api_response = api_instance.update_instance(instanceId, instance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InstanceApi->updateInstance: %s\n" % e)
extern crate InstanceApi;

pub fn main() {
    let instanceId = instanceId_example; // String
    let instance = ; // Instance

    let mut context = InstanceApi::Context::default();
    let result = client.updateInstance(instanceId, instance, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
instanceId*
String
The ID of the virtual machine instance.
Required
Body parameters
Name Description
instance *

Instance payload.

Responses


Kaktus

createKaktus

Creates a new Kaktus computing node.


/zone/{zoneId}/kaktus

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/zone/{zoneId}/kaktus" \
 -d '{
  "memory_cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "name" : "name",
  "description" : "description",
  "overcommit_memory_ratio" : 1,
  "cpu_cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "id" : "id",
  "overcommit_cpu_ratio" : 6,
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KaktusApi;

import java.io.File;
import java.util.*;

public class KaktusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KaktusApi apiInstance = new KaktusApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kaktus kaktus = ; // Kaktus | 

        try {
            Kaktus result = apiInstance.createKaktus(zoneId, kaktus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#createKaktus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String zoneId = new String(); // String | The ID of the availability zone.
final Kaktus kaktus = new Kaktus(); // Kaktus | 

try {
    final result = await api_instance.createKaktus(zoneId, kaktus);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createKaktus: $e\n');
}

import org.openapitools.client.api.KaktusApi;

public class KaktusApiExample {
    public static void main(String[] args) {
        KaktusApi apiInstance = new KaktusApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kaktus kaktus = ; // Kaktus | 

        try {
            Kaktus result = apiInstance.createKaktus(zoneId, kaktus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#createKaktus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KaktusApi *apiInstance = [[KaktusApi alloc] init];
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Kaktus *kaktus = ; // 

[apiInstance createKaktusWith:zoneId
    kaktus:kaktus
              completionHandler: ^(Kaktus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KaktusApi()
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var kaktus = ; // {Kaktus} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createKaktus(zoneId, kaktus, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createKaktusExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KaktusApi();
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var kaktus = new Kaktus(); // Kaktus | 

            try {
                Kaktus result = apiInstance.createKaktus(zoneId, kaktus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KaktusApi.createKaktus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KaktusApi();
$zoneId = zoneId_example; // String | The ID of the availability zone.
$kaktus = ; // Kaktus | 

try {
    $result = $api_instance->createKaktus($zoneId, $kaktus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KaktusApi->createKaktus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KaktusApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KaktusApi->new();
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $kaktus = WWW::OPenAPIClient::Object::Kaktus->new(); # Kaktus | 

eval {
    my $result = $api_instance->createKaktus(zoneId => $zoneId, kaktus => $kaktus);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KaktusApi->createKaktus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KaktusApi()
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
kaktus =  # Kaktus | 

try:
    api_response = api_instance.create_kaktus(zoneId, kaktus)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KaktusApi->createKaktus: %s\n" % e)
extern crate KaktusApi;

pub fn main() {
    let zoneId = zoneId_example; // String
    let kaktus = ; // Kaktus

    let mut context = KaktusApi::Context::default();
    let result = client.createKaktus(zoneId, kaktus, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
kaktus *

Kaktus payload.

Responses


deleteKaktus

Deletes an existing Kaktus computing node.


/kaktus/{kaktusId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kaktus/{kaktusId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KaktusApi;

import java.io.File;
import java.util.*;

public class KaktusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            apiInstance.deleteKaktus(kaktusId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#deleteKaktus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kaktusId = new String(); // String | The ID of the Kaktus computing node.

try {
    final result = await api_instance.deleteKaktus(kaktusId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteKaktus: $e\n');
}

import org.openapitools.client.api.KaktusApi;

public class KaktusApiExample {
    public static void main(String[] args) {
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            apiInstance.deleteKaktus(kaktusId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#deleteKaktus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KaktusApi *apiInstance = [[KaktusApi alloc] init];
String *kaktusId = kaktusId_example; // The ID of the Kaktus computing node. (default to null)

[apiInstance deleteKaktusWith:kaktusId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KaktusApi()
var kaktusId = kaktusId_example; // {String} The ID of the Kaktus computing node.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKaktus(kaktusId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteKaktusExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KaktusApi();
            var kaktusId = kaktusId_example;  // String | The ID of the Kaktus computing node. (default to null)

            try {
                apiInstance.deleteKaktus(kaktusId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KaktusApi.deleteKaktus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KaktusApi();
$kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

try {
    $api_instance->deleteKaktus($kaktusId);
} catch (Exception $e) {
    echo 'Exception when calling KaktusApi->deleteKaktus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KaktusApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KaktusApi->new();
my $kaktusId = kaktusId_example; # String | The ID of the Kaktus computing node.

eval {
    $api_instance->deleteKaktus(kaktusId => $kaktusId);
};
if ($@) {
    warn "Exception when calling KaktusApi->deleteKaktus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KaktusApi()
kaktusId = kaktusId_example # String | The ID of the Kaktus computing node. (default to null)

try:
    api_instance.delete_kaktus(kaktusId)
except ApiException as e:
    print("Exception when calling KaktusApi->deleteKaktus: %s\n" % e)
extern crate KaktusApi;

pub fn main() {
    let kaktusId = kaktusId_example; // String

    let mut context = KaktusApi::Context::default();
    let result = client.deleteKaktus(kaktusId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kaktusId*
String
The ID of the Kaktus computing node.
Required

Responses


listKaktusInstances

Returns the IDs of virtual machine instance objects.


/kaktus/{kaktusId}/instances

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kaktus/{kaktusId}/instances"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KaktusApi;

import java.io.File;
import java.util.*;

public class KaktusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            array['String'] result = apiInstance.listKaktusInstances(kaktusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#listKaktusInstances");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kaktusId = new String(); // String | The ID of the Kaktus computing node.

try {
    final result = await api_instance.listKaktusInstances(kaktusId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKaktusInstances: $e\n');
}

import org.openapitools.client.api.KaktusApi;

public class KaktusApiExample {
    public static void main(String[] args) {
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            array['String'] result = apiInstance.listKaktusInstances(kaktusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#listKaktusInstances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KaktusApi *apiInstance = [[KaktusApi alloc] init];
String *kaktusId = kaktusId_example; // The ID of the Kaktus computing node. (default to null)

[apiInstance listKaktusInstancesWith:kaktusId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KaktusApi()
var kaktusId = kaktusId_example; // {String} The ID of the Kaktus computing node.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKaktusInstances(kaktusId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKaktusInstancesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KaktusApi();
            var kaktusId = kaktusId_example;  // String | The ID of the Kaktus computing node. (default to null)

            try {
                array['String'] result = apiInstance.listKaktusInstances(kaktusId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KaktusApi.listKaktusInstances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KaktusApi();
$kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

try {
    $result = $api_instance->listKaktusInstances($kaktusId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KaktusApi->listKaktusInstances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KaktusApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KaktusApi->new();
my $kaktusId = kaktusId_example; # String | The ID of the Kaktus computing node.

eval {
    my $result = $api_instance->listKaktusInstances(kaktusId => $kaktusId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KaktusApi->listKaktusInstances: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KaktusApi()
kaktusId = kaktusId_example # String | The ID of the Kaktus computing node. (default to null)

try:
    api_response = api_instance.list_kaktus_instances(kaktusId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KaktusApi->listKaktusInstances: %s\n" % e)
extern crate KaktusApi;

pub fn main() {
    let kaktusId = kaktusId_example; // String

    let mut context = KaktusApi::Context::default();
    let result = client.listKaktusInstances(kaktusId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kaktusId*
String
The ID of the Kaktus computing node.
Required

Responses


listKaktuss

Returns the IDs of Kaktus computing node objects.


/kaktus

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kaktus"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KaktusApi;

import java.io.File;
import java.util.*;

public class KaktusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KaktusApi apiInstance = new KaktusApi();

        try {
            array['String'] result = apiInstance.listKaktuss();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#listKaktuss");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listKaktuss();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKaktuss: $e\n');
}

import org.openapitools.client.api.KaktusApi;

public class KaktusApiExample {
    public static void main(String[] args) {
        KaktusApi apiInstance = new KaktusApi();

        try {
            array['String'] result = apiInstance.listKaktuss();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#listKaktuss");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KaktusApi *apiInstance = [[KaktusApi alloc] init];

[apiInstance listKaktussWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KaktusApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKaktuss(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKaktussExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KaktusApi();

            try {
                array['String'] result = apiInstance.listKaktuss();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KaktusApi.listKaktuss: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KaktusApi();

try {
    $result = $api_instance->listKaktuss();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KaktusApi->listKaktuss: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KaktusApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KaktusApi->new();

eval {
    my $result = $api_instance->listKaktuss();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KaktusApi->listKaktuss: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KaktusApi()

try:
    api_response = api_instance.list_kaktuss()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KaktusApi->listKaktuss: %s\n" % e)
extern crate KaktusApi;

pub fn main() {

    let mut context = KaktusApi::Context::default();
    let result = client.listKaktuss(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listZoneKaktuses

Returns the IDs of Kaktus computing node objects.


/zone/{zoneId}/kaktuses

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/zone/{zoneId}/kaktuses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KaktusApi;

import java.io.File;
import java.util.*;

public class KaktusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KaktusApi apiInstance = new KaktusApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listZoneKaktuses(zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#listZoneKaktuses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listZoneKaktuses(zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listZoneKaktuses: $e\n');
}

import org.openapitools.client.api.KaktusApi;

public class KaktusApiExample {
    public static void main(String[] args) {
        KaktusApi apiInstance = new KaktusApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listZoneKaktuses(zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#listZoneKaktuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KaktusApi *apiInstance = [[KaktusApi alloc] init];
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listZoneKaktusesWith:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KaktusApi()
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listZoneKaktuses(zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listZoneKaktusesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KaktusApi();
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listZoneKaktuses(zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KaktusApi.listZoneKaktuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KaktusApi();
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listZoneKaktuses($zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KaktusApi->listZoneKaktuses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KaktusApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KaktusApi->new();
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listZoneKaktuses(zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KaktusApi->listZoneKaktuses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KaktusApi()
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_zone_kaktuses(zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KaktusApi->listZoneKaktuses: %s\n" % e)
extern crate KaktusApi;

pub fn main() {
    let zoneId = zoneId_example; // String

    let mut context = KaktusApi::Context::default();
    let result = client.listZoneKaktuses(zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
zoneId*
String
The ID of the availability zone.
Required

Responses


readKaktus

Returns a Kaktus computing node.


/kaktus/{kaktusId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kaktus/{kaktusId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KaktusApi;

import java.io.File;
import java.util.*;

public class KaktusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            Kaktus result = apiInstance.readKaktus(kaktusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#readKaktus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kaktusId = new String(); // String | The ID of the Kaktus computing node.

try {
    final result = await api_instance.readKaktus(kaktusId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKaktus: $e\n');
}

import org.openapitools.client.api.KaktusApi;

public class KaktusApiExample {
    public static void main(String[] args) {
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            Kaktus result = apiInstance.readKaktus(kaktusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#readKaktus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KaktusApi *apiInstance = [[KaktusApi alloc] init];
String *kaktusId = kaktusId_example; // The ID of the Kaktus computing node. (default to null)

[apiInstance readKaktusWith:kaktusId
              completionHandler: ^(Kaktus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KaktusApi()
var kaktusId = kaktusId_example; // {String} The ID of the Kaktus computing node.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKaktus(kaktusId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKaktusExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KaktusApi();
            var kaktusId = kaktusId_example;  // String | The ID of the Kaktus computing node. (default to null)

            try {
                Kaktus result = apiInstance.readKaktus(kaktusId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KaktusApi.readKaktus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KaktusApi();
$kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

try {
    $result = $api_instance->readKaktus($kaktusId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KaktusApi->readKaktus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KaktusApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KaktusApi->new();
my $kaktusId = kaktusId_example; # String | The ID of the Kaktus computing node.

eval {
    my $result = $api_instance->readKaktus(kaktusId => $kaktusId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KaktusApi->readKaktus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KaktusApi()
kaktusId = kaktusId_example # String | The ID of the Kaktus computing node. (default to null)

try:
    api_response = api_instance.read_kaktus(kaktusId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KaktusApi->readKaktus: %s\n" % e)
extern crate KaktusApi;

pub fn main() {
    let kaktusId = kaktusId_example; // String

    let mut context = KaktusApi::Context::default();
    let result = client.readKaktus(kaktusId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kaktusId*
String
The ID of the Kaktus computing node.
Required

Responses


readKaktusCaps

Returns a Kaktus computing node capability.


/kaktus/{kaktusId}/caps

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kaktus/{kaktusId}/caps"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KaktusApi;

import java.io.File;
import java.util.*;

public class KaktusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            KaktusCaps result = apiInstance.readKaktusCaps(kaktusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#readKaktusCaps");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kaktusId = new String(); // String | The ID of the Kaktus computing node.

try {
    final result = await api_instance.readKaktusCaps(kaktusId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKaktusCaps: $e\n');
}

import org.openapitools.client.api.KaktusApi;

public class KaktusApiExample {
    public static void main(String[] args) {
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

        try {
            KaktusCaps result = apiInstance.readKaktusCaps(kaktusId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#readKaktusCaps");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KaktusApi *apiInstance = [[KaktusApi alloc] init];
String *kaktusId = kaktusId_example; // The ID of the Kaktus computing node. (default to null)

[apiInstance readKaktusCapsWith:kaktusId
              completionHandler: ^(KaktusCaps output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KaktusApi()
var kaktusId = kaktusId_example; // {String} The ID of the Kaktus computing node.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKaktusCaps(kaktusId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKaktusCapsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KaktusApi();
            var kaktusId = kaktusId_example;  // String | The ID of the Kaktus computing node. (default to null)

            try {
                KaktusCaps result = apiInstance.readKaktusCaps(kaktusId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KaktusApi.readKaktusCaps: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KaktusApi();
$kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.

try {
    $result = $api_instance->readKaktusCaps($kaktusId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KaktusApi->readKaktusCaps: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KaktusApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KaktusApi->new();
my $kaktusId = kaktusId_example; # String | The ID of the Kaktus computing node.

eval {
    my $result = $api_instance->readKaktusCaps(kaktusId => $kaktusId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KaktusApi->readKaktusCaps: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KaktusApi()
kaktusId = kaktusId_example # String | The ID of the Kaktus computing node. (default to null)

try:
    api_response = api_instance.read_kaktus_caps(kaktusId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KaktusApi->readKaktusCaps: %s\n" % e)
extern crate KaktusApi;

pub fn main() {
    let kaktusId = kaktusId_example; // String

    let mut context = KaktusApi::Context::default();
    let result = client.readKaktusCaps(kaktusId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kaktusId*
String
The ID of the Kaktus computing node.
Required

Responses


updateKaktus

Updates a Kaktus computing node configuration.


/kaktus/{kaktusId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kaktus/{kaktusId}" \
 -d '{
  "memory_cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "name" : "name",
  "description" : "description",
  "overcommit_memory_ratio" : 1,
  "cpu_cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "id" : "id",
  "overcommit_cpu_ratio" : 6,
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KaktusApi;

import java.io.File;
import java.util.*;

public class KaktusApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.
        Kaktus kaktus = ; // Kaktus | 

        try {
            Kaktus result = apiInstance.updateKaktus(kaktusId, kaktus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#updateKaktus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kaktusId = new String(); // String | The ID of the Kaktus computing node.
final Kaktus kaktus = new Kaktus(); // Kaktus | 

try {
    final result = await api_instance.updateKaktus(kaktusId, kaktus);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKaktus: $e\n');
}

import org.openapitools.client.api.KaktusApi;

public class KaktusApiExample {
    public static void main(String[] args) {
        KaktusApi apiInstance = new KaktusApi();
        String kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.
        Kaktus kaktus = ; // Kaktus | 

        try {
            Kaktus result = apiInstance.updateKaktus(kaktusId, kaktus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KaktusApi#updateKaktus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KaktusApi *apiInstance = [[KaktusApi alloc] init];
String *kaktusId = kaktusId_example; // The ID of the Kaktus computing node. (default to null)
Kaktus *kaktus = ; // 

[apiInstance updateKaktusWith:kaktusId
    kaktus:kaktus
              completionHandler: ^(Kaktus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KaktusApi()
var kaktusId = kaktusId_example; // {String} The ID of the Kaktus computing node.
var kaktus = ; // {Kaktus} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKaktus(kaktusId, kaktus, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateKaktusExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KaktusApi();
            var kaktusId = kaktusId_example;  // String | The ID of the Kaktus computing node. (default to null)
            var kaktus = new Kaktus(); // Kaktus | 

            try {
                Kaktus result = apiInstance.updateKaktus(kaktusId, kaktus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KaktusApi.updateKaktus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KaktusApi();
$kaktusId = kaktusId_example; // String | The ID of the Kaktus computing node.
$kaktus = ; // Kaktus | 

try {
    $result = $api_instance->updateKaktus($kaktusId, $kaktus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KaktusApi->updateKaktus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KaktusApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KaktusApi->new();
my $kaktusId = kaktusId_example; # String | The ID of the Kaktus computing node.
my $kaktus = WWW::OPenAPIClient::Object::Kaktus->new(); # Kaktus | 

eval {
    my $result = $api_instance->updateKaktus(kaktusId => $kaktusId, kaktus => $kaktus);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KaktusApi->updateKaktus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KaktusApi()
kaktusId = kaktusId_example # String | The ID of the Kaktus computing node. (default to null)
kaktus =  # Kaktus | 

try:
    api_response = api_instance.update_kaktus(kaktusId, kaktus)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KaktusApi->updateKaktus: %s\n" % e)
extern crate KaktusApi;

pub fn main() {
    let kaktusId = kaktusId_example; // String
    let kaktus = ; // Kaktus

    let mut context = KaktusApi::Context::default();
    let result = client.updateKaktus(kaktusId, kaktus, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kaktusId*
String
The ID of the Kaktus computing node.
Required
Body parameters
Name Description
kaktus *

Kaktus payload.

Responses


Kawaii

createKawaiiIpSec

Creates a new Kawaii IPsec connection.


/kawaii/{kawaiiId}/ipsec

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec" \
 -d '{
  "pre_shared_key" : "pre_shared_key",
  "phase1_dh_group_number" : 0,
  "phase1_encryption_algorithm" : "AES128",
  "phase2_encryption_algorithm" : "AES128",
  "ip" : "ip",
  "phase1_integrity_algorithm" : "SHA1",
  "phase1_lifetime" : "1h",
  "description" : "description",
  "dpd_timeout" : "240s",
  "dpd_timeout_action" : "restart",
  "start_action" : "start",
  "rekey_time" : "2h",
  "remote_ip" : "remote_ip",
  "phase2_lifetime" : "1h",
  "phase2_dh_group_number" : 6,
  "firewall" : {
    "ingress" : [ {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    } ],
    "egress_policy" : "accept",
    "egress" : [ {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    } ]
  },
  "name" : "name",
  "phase2_integrity_algorithm" : "SHA1",
  "remote_subnet" : "remote_subnet",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        KawaiiIpSec kawaiiIpSec = ; // KawaiiIpSec | 

        try {
            KawaiiIpSec result = apiInstance.createKawaiiIpSec(kawaiiId, kawaiiIpSec);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#createKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final KawaiiIpSec kawaiiIpSec = new KawaiiIpSec(); // KawaiiIpSec | 

try {
    final result = await api_instance.createKawaiiIpSec(kawaiiId, kawaiiIpSec);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createKawaiiIpSec: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        KawaiiIpSec kawaiiIpSec = ; // KawaiiIpSec | 

        try {
            KawaiiIpSec result = apiInstance.createKawaiiIpSec(kawaiiId, kawaiiIpSec);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#createKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
KawaiiIpSec *kawaiiIpSec = ; // 

[apiInstance createKawaiiIpSecWith:kawaiiId
    kawaiiIpSec:kawaiiIpSec
              completionHandler: ^(KawaiiIpSec output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaiiIpSec = ; // {KawaiiIpSec} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createKawaiiIpSec(kawaiiId, kawaiiIpSec, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createKawaiiIpSecExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaiiIpSec = new KawaiiIpSec(); // KawaiiIpSec | 

            try {
                KawaiiIpSec result = apiInstance.createKawaiiIpSec(kawaiiId, kawaiiIpSec);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.createKawaiiIpSec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaiiIpSec = ; // KawaiiIpSec | 

try {
    $result = $api_instance->createKawaiiIpSec($kawaiiId, $kawaiiIpSec);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->createKawaiiIpSec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaiiIpSec = WWW::OPenAPIClient::Object::KawaiiIpSec->new(); # KawaiiIpSec | 

eval {
    my $result = $api_instance->createKawaiiIpSec(kawaiiId => $kawaiiId, kawaiiIpSec => $kawaiiIpSec);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->createKawaiiIpSec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaiiIpSec =  # KawaiiIpSec | 

try:
    api_response = api_instance.create_kawaii_ip_sec(kawaiiId, kawaiiIpSec)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->createKawaiiIpSec: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaiiIpSec = ; // KawaiiIpSec

    let mut context = KawaiiApi::Context::default();
    let result = client.createKawaiiIpSec(kawaiiId, kawaiiIpSec, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
Body parameters
Name Description
kawaiiIpSec *

KawaiiIpSec payload.

Responses


createProjectRegionKawaii

Creates a new Kawaii.


/project/{projectId}/region/{regionId}/kawaii

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kawaii" \
 -d '{
  "ipsec_connections" : [ {
    "pre_shared_key" : "pre_shared_key",
    "phase1_dh_group_number" : 0,
    "phase1_encryption_algorithm" : "AES128",
    "phase2_encryption_algorithm" : "AES128",
    "ip" : "ip",
    "phase1_integrity_algorithm" : "SHA1",
    "phase1_lifetime" : "1h",
    "description" : "description",
    "dpd_timeout" : "240s",
    "dpd_timeout_action" : "restart",
    "start_action" : "start",
    "rekey_time" : "2h",
    "remote_ip" : "remote_ip",
    "phase2_lifetime" : "1h",
    "phase2_dh_group_number" : 6,
    "firewall" : {
      "ingress" : [ {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      } ],
      "egress_policy" : "accept",
      "egress" : [ {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      } ]
    },
    "name" : "name",
    "phase2_integrity_algorithm" : "SHA1",
    "remote_subnet" : "remote_subnet",
    "id" : "id"
  }, {
    "pre_shared_key" : "pre_shared_key",
    "phase1_dh_group_number" : 0,
    "phase1_encryption_algorithm" : "AES128",
    "phase2_encryption_algorithm" : "AES128",
    "ip" : "ip",
    "phase1_integrity_algorithm" : "SHA1",
    "phase1_lifetime" : "1h",
    "description" : "description",
    "dpd_timeout" : "240s",
    "dpd_timeout_action" : "restart",
    "start_action" : "start",
    "rekey_time" : "2h",
    "remote_ip" : "remote_ip",
    "phase2_lifetime" : "1h",
    "phase2_dh_group_number" : 6,
    "firewall" : {
      "ingress" : [ {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      } ],
      "egress_policy" : "accept",
      "egress" : [ {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      } ]
    },
    "name" : "name",
    "phase2_integrity_algorithm" : "SHA1",
    "remote_subnet" : "remote_subnet",
    "id" : "id"
  } ],
  "dnat" : [ {
    "protocol" : "tcp",
    "destination" : "destination",
    "ports" : "ports"
  }, {
    "protocol" : "tcp",
    "destination" : "destination",
    "ports" : "ports"
  } ],
  "firewall" : {
    "ingress" : [ {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    } ],
    "egress_policy" : "accept",
    "egress" : [ {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    } ]
  },
  "name" : "name",
  "description" : "description",
  "netip" : {
    "private" : [ "private", "private" ],
    "public" : [ "public", "public" ],
    "zones" : [ {
      "private" : "private",
      "public" : "public",
      "zone" : "zone"
    }, {
      "private" : "private",
      "public" : "public",
      "zone" : "zone"
    } ]
  },
  "id" : "id",
  "vpc_peerings" : [ {
    "subnet" : "subnet",
    "ingress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ],
    "netip" : [ {
      "private" : "private",
      "zone" : "zone"
    }, {
      "private" : "private",
      "zone" : "zone"
    } ],
    "policy" : "drop",
    "egress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ]
  }, {
    "subnet" : "subnet",
    "ingress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ],
    "netip" : [ {
      "private" : "private",
      "zone" : "zone"
    }, {
      "private" : "private",
      "zone" : "zone"
    } ],
    "policy" : "drop",
    "egress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kawaii kawaii = ; // Kawaii | 

        try {
            Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#createProjectRegionKawaii");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Kawaii kawaii = new Kawaii(); // Kawaii | 

try {
    final result = await api_instance.createProjectRegionKawaii(projectId, regionId, kawaii);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKawaii: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kawaii kawaii = ; // Kawaii | 

        try {
            Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#createProjectRegionKawaii");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Kawaii *kawaii = ; // 

[apiInstance createProjectRegionKawaiiWith:projectId
    regionId:regionId
    kawaii:kawaii
              completionHandler: ^(Kawaii output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var kawaii = ; // {Kawaii} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKawaii(projectId, regionId, kawaii, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKawaiiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var kawaii = new Kawaii(); // Kawaii | 

            try {
                Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.createProjectRegionKawaii: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$kawaii = ; // Kawaii | 

try {
    $result = $api_instance->createProjectRegionKawaii($projectId, $regionId, $kawaii);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->createProjectRegionKawaii: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $kawaii = WWW::OPenAPIClient::Object::Kawaii->new(); # Kawaii | 

eval {
    my $result = $api_instance->createProjectRegionKawaii(projectId => $projectId, regionId => $regionId, kawaii => $kawaii);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->createProjectRegionKawaii: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
kawaii =  # Kawaii | 

try:
    api_response = api_instance.create_project_region_kawaii(projectId, regionId, kawaii)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->createProjectRegionKawaii: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let kawaii = ; // Kawaii

    let mut context = KawaiiApi::Context::default();
    let result = client.createProjectRegionKawaii(projectId, regionId, kawaii, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
kawaii *

Kawaii payload.

Responses


deleteKawaii

Deletes an existing Kawaii.


/kawaii/{kawaiiId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii/{kawaiiId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

        try {
            apiInstance.deleteKawaii(kawaiiId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#deleteKawaii");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.

try {
    final result = await api_instance.deleteKawaii(kawaiiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteKawaii: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

        try {
            apiInstance.deleteKawaii(kawaiiId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#deleteKawaii");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)

[apiInstance deleteKawaiiWith:kawaiiId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKawaii(kawaiiId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteKawaiiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)

            try {
                apiInstance.deleteKawaii(kawaiiId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.deleteKawaii: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

try {
    $api_instance->deleteKawaii($kawaiiId);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->deleteKawaii: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.

eval {
    $api_instance->deleteKawaii(kawaiiId => $kawaiiId);
};
if ($@) {
    warn "Exception when calling KawaiiApi->deleteKawaii: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)

try:
    api_instance.delete_kawaii(kawaiiId)
except ApiException as e:
    print("Exception when calling KawaiiApi->deleteKawaii: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String

    let mut context = KawaiiApi::Context::default();
    let result = client.deleteKawaii(kawaiiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required

Responses


deleteKawaiiIpSec

Deletes an existing Kawaii IPsec connection.


/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

        try {
            apiInstance.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#deleteKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final String kawaiiIpSecId = new String(); // String | The ID of the Kawaii IPsec connection.

try {
    final result = await api_instance.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteKawaiiIpSec: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

        try {
            apiInstance.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#deleteKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
String *kawaiiIpSecId = kawaiiIpSecId_example; // The ID of the Kawaii IPsec connection. (default to null)

[apiInstance deleteKawaiiIpSecWith:kawaiiId
    kawaiiIpSecId:kawaiiIpSecId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaiiIpSecId = kawaiiIpSecId_example; // {String} The ID of the Kawaii IPsec connection.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteKawaiiIpSecExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaiiIpSecId = kawaiiIpSecId_example;  // String | The ID of the Kawaii IPsec connection. (default to null)

            try {
                apiInstance.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.deleteKawaiiIpSec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

try {
    $api_instance->deleteKawaiiIpSec($kawaiiId, $kawaiiIpSecId);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->deleteKawaiiIpSec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaiiIpSecId = kawaiiIpSecId_example; # String | The ID of the Kawaii IPsec connection.

eval {
    $api_instance->deleteKawaiiIpSec(kawaiiId => $kawaiiId, kawaiiIpSecId => $kawaiiIpSecId);
};
if ($@) {
    warn "Exception when calling KawaiiApi->deleteKawaiiIpSec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaiiIpSecId = kawaiiIpSecId_example # String | The ID of the Kawaii IPsec connection. (default to null)

try:
    api_instance.delete_kawaii_ip_sec(kawaiiId, kawaiiIpSecId)
except ApiException as e:
    print("Exception when calling KawaiiApi->deleteKawaiiIpSec: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaiiIpSecId = kawaiiIpSecId_example; // String

    let mut context = KawaiiApi::Context::default();
    let result = client.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
KawaiiIpSecId*
String
The ID of the Kawaii IPsec connection.
Required

Responses


listKawaiiIpSecs

Returns the IDs of Kawaii IPsec connection objects.


/kawaii/{kawaiiId}/ipsec

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

        try {
            array['String'] result = apiInstance.listKawaiiIpSecs(kawaiiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#listKawaiiIpSecs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.

try {
    final result = await api_instance.listKawaiiIpSecs(kawaiiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKawaiiIpSecs: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

        try {
            array['String'] result = apiInstance.listKawaiiIpSecs(kawaiiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#listKawaiiIpSecs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)

[apiInstance listKawaiiIpSecsWith:kawaiiId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKawaiiIpSecs(kawaiiId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKawaiiIpSecsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)

            try {
                array['String'] result = apiInstance.listKawaiiIpSecs(kawaiiId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.listKawaiiIpSecs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

try {
    $result = $api_instance->listKawaiiIpSecs($kawaiiId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->listKawaiiIpSecs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.

eval {
    my $result = $api_instance->listKawaiiIpSecs(kawaiiId => $kawaiiId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->listKawaiiIpSecs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)

try:
    api_response = api_instance.list_kawaii_ip_secs(kawaiiId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->listKawaiiIpSecs: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String

    let mut context = KawaiiApi::Context::default();
    let result = client.listKawaiiIpSecs(kawaiiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required

Responses


listKawaiis

Returns the IDs of Kawaii objects.


/kawaii

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();

        try {
            array['String'] result = apiInstance.listKawaiis();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#listKawaiis");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listKawaiis();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKawaiis: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();

        try {
            array['String'] result = apiInstance.listKawaiis();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#listKawaiis");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];

[apiInstance listKawaiisWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKawaiis(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKawaiisExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();

            try {
                array['String'] result = apiInstance.listKawaiis();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.listKawaiis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();

try {
    $result = $api_instance->listKawaiis();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->listKawaiis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();

eval {
    my $result = $api_instance->listKawaiis();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->listKawaiis: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()

try:
    api_response = api_instance.list_kawaiis()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->listKawaiis: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {

    let mut context = KawaiiApi::Context::default();
    let result = client.listKawaiis(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listProjectRegionKawaiis

Returns the IDs of Kawaii objects.


/project/{projectId}/region/{regionId}/kawaiis

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kawaiis"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#listProjectRegionKawaiis");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionKawaiis(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKawaiis: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#listProjectRegionKawaiis");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionKawaiisWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKawaiis(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKawaiisExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.listProjectRegionKawaiis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionKawaiis($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->listProjectRegionKawaiis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionKawaiis(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->listProjectRegionKawaiis: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_kawaiis(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->listProjectRegionKawaiis: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = KawaiiApi::Context::default();
    let result = client.listProjectRegionKawaiis(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


readKawaii

Returns a Kawaii.


/kawaii/{kawaiiId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii/{kawaiiId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

        try {
            Kawaii result = apiInstance.readKawaii(kawaiiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#readKawaii");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.

try {
    final result = await api_instance.readKawaii(kawaiiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKawaii: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

        try {
            Kawaii result = apiInstance.readKawaii(kawaiiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#readKawaii");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)

[apiInstance readKawaiiWith:kawaiiId
              completionHandler: ^(Kawaii output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKawaii(kawaiiId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKawaiiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)

            try {
                Kawaii result = apiInstance.readKawaii(kawaiiId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.readKawaii: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

try {
    $result = $api_instance->readKawaii($kawaiiId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->readKawaii: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.

eval {
    my $result = $api_instance->readKawaii(kawaiiId => $kawaiiId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->readKawaii: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)

try:
    api_response = api_instance.read_kawaii(kawaiiId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->readKawaii: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String

    let mut context = KawaiiApi::Context::default();
    let result = client.readKawaii(kawaiiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required

Responses


readKawaiiIpSec

Returns a Kawaii IPsec connection.


/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

        try {
            KawaiiIpSec result = apiInstance.readKawaiiIpSec(kawaiiId, kawaiiIpSecId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#readKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final String kawaiiIpSecId = new String(); // String | The ID of the Kawaii IPsec connection.

try {
    final result = await api_instance.readKawaiiIpSec(kawaiiId, kawaiiIpSecId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKawaiiIpSec: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

        try {
            KawaiiIpSec result = apiInstance.readKawaiiIpSec(kawaiiId, kawaiiIpSecId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#readKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
String *kawaiiIpSecId = kawaiiIpSecId_example; // The ID of the Kawaii IPsec connection. (default to null)

[apiInstance readKawaiiIpSecWith:kawaiiId
    kawaiiIpSecId:kawaiiIpSecId
              completionHandler: ^(KawaiiIpSec output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaiiIpSecId = kawaiiIpSecId_example; // {String} The ID of the Kawaii IPsec connection.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKawaiiIpSec(kawaiiId, kawaiiIpSecId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKawaiiIpSecExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaiiIpSecId = kawaiiIpSecId_example;  // String | The ID of the Kawaii IPsec connection. (default to null)

            try {
                KawaiiIpSec result = apiInstance.readKawaiiIpSec(kawaiiId, kawaiiIpSecId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.readKawaiiIpSec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

try {
    $result = $api_instance->readKawaiiIpSec($kawaiiId, $kawaiiIpSecId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->readKawaiiIpSec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaiiIpSecId = kawaiiIpSecId_example; # String | The ID of the Kawaii IPsec connection.

eval {
    my $result = $api_instance->readKawaiiIpSec(kawaiiId => $kawaiiId, kawaiiIpSecId => $kawaiiIpSecId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->readKawaiiIpSec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaiiIpSecId = kawaiiIpSecId_example # String | The ID of the Kawaii IPsec connection. (default to null)

try:
    api_response = api_instance.read_kawaii_ip_sec(kawaiiId, kawaiiIpSecId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->readKawaiiIpSec: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaiiIpSecId = kawaiiIpSecId_example; // String

    let mut context = KawaiiApi::Context::default();
    let result = client.readKawaiiIpSec(kawaiiId, kawaiiIpSecId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
KawaiiIpSecId*
String
The ID of the Kawaii IPsec connection.
Required

Responses


updateKawaii

Updates a Kawaii configuration.


/kawaii/{kawaiiId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kawaii/{kawaiiId}" \
 -d '{
  "ipsec_connections" : [ {
    "pre_shared_key" : "pre_shared_key",
    "phase1_dh_group_number" : 0,
    "phase1_encryption_algorithm" : "AES128",
    "phase2_encryption_algorithm" : "AES128",
    "ip" : "ip",
    "phase1_integrity_algorithm" : "SHA1",
    "phase1_lifetime" : "1h",
    "description" : "description",
    "dpd_timeout" : "240s",
    "dpd_timeout_action" : "restart",
    "start_action" : "start",
    "rekey_time" : "2h",
    "remote_ip" : "remote_ip",
    "phase2_lifetime" : "1h",
    "phase2_dh_group_number" : 6,
    "firewall" : {
      "ingress" : [ {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      } ],
      "egress_policy" : "accept",
      "egress" : [ {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      } ]
    },
    "name" : "name",
    "phase2_integrity_algorithm" : "SHA1",
    "remote_subnet" : "remote_subnet",
    "id" : "id"
  }, {
    "pre_shared_key" : "pre_shared_key",
    "phase1_dh_group_number" : 0,
    "phase1_encryption_algorithm" : "AES128",
    "phase2_encryption_algorithm" : "AES128",
    "ip" : "ip",
    "phase1_integrity_algorithm" : "SHA1",
    "phase1_lifetime" : "1h",
    "description" : "description",
    "dpd_timeout" : "240s",
    "dpd_timeout_action" : "restart",
    "start_action" : "start",
    "rekey_time" : "2h",
    "remote_ip" : "remote_ip",
    "phase2_lifetime" : "1h",
    "phase2_dh_group_number" : 6,
    "firewall" : {
      "ingress" : [ {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      } ],
      "egress_policy" : "accept",
      "egress" : [ {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      } ]
    },
    "name" : "name",
    "phase2_integrity_algorithm" : "SHA1",
    "remote_subnet" : "remote_subnet",
    "id" : "id"
  } ],
  "dnat" : [ {
    "protocol" : "tcp",
    "destination" : "destination",
    "ports" : "ports"
  }, {
    "protocol" : "tcp",
    "destination" : "destination",
    "ports" : "ports"
  } ],
  "firewall" : {
    "ingress" : [ {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    } ],
    "egress_policy" : "accept",
    "egress" : [ {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    } ]
  },
  "name" : "name",
  "description" : "description",
  "netip" : {
    "private" : [ "private", "private" ],
    "public" : [ "public", "public" ],
    "zones" : [ {
      "private" : "private",
      "public" : "public",
      "zone" : "zone"
    }, {
      "private" : "private",
      "public" : "public",
      "zone" : "zone"
    } ]
  },
  "id" : "id",
  "vpc_peerings" : [ {
    "subnet" : "subnet",
    "ingress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ],
    "netip" : [ {
      "private" : "private",
      "zone" : "zone"
    }, {
      "private" : "private",
      "zone" : "zone"
    } ],
    "policy" : "drop",
    "egress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ]
  }, {
    "subnet" : "subnet",
    "ingress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ],
    "netip" : [ {
      "private" : "private",
      "zone" : "zone"
    }, {
      "private" : "private",
      "zone" : "zone"
    } ],
    "policy" : "drop",
    "egress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        Kawaii kawaii = ; // Kawaii | 

        try {
            Kawaii result = apiInstance.updateKawaii(kawaiiId, kawaii);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#updateKawaii");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final Kawaii kawaii = new Kawaii(); // Kawaii | 

try {
    final result = await api_instance.updateKawaii(kawaiiId, kawaii);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKawaii: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        Kawaii kawaii = ; // Kawaii | 

        try {
            Kawaii result = apiInstance.updateKawaii(kawaiiId, kawaii);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#updateKawaii");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
Kawaii *kawaii = ; // 

[apiInstance updateKawaiiWith:kawaiiId
    kawaii:kawaii
              completionHandler: ^(Kawaii output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaii = ; // {Kawaii} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKawaii(kawaiiId, kawaii, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateKawaiiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaii = new Kawaii(); // Kawaii | 

            try {
                Kawaii result = apiInstance.updateKawaii(kawaiiId, kawaii);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.updateKawaii: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaii = ; // Kawaii | 

try {
    $result = $api_instance->updateKawaii($kawaiiId, $kawaii);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->updateKawaii: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaii = WWW::OPenAPIClient::Object::Kawaii->new(); # Kawaii | 

eval {
    my $result = $api_instance->updateKawaii(kawaiiId => $kawaiiId, kawaii => $kawaii);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->updateKawaii: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaii =  # Kawaii | 

try:
    api_response = api_instance.update_kawaii(kawaiiId, kawaii)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->updateKawaii: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaii = ; // Kawaii

    let mut context = KawaiiApi::Context::default();
    let result = client.updateKawaii(kawaiiId, kawaii, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
Body parameters
Name Description
kawaii *

Kawaii payload.

Responses


updateKawaiiIpSec

Updates a Kawaii IPsec connection configuration.


/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}" \
 -d '{
  "pre_shared_key" : "pre_shared_key",
  "phase1_dh_group_number" : 0,
  "phase1_encryption_algorithm" : "AES128",
  "phase2_encryption_algorithm" : "AES128",
  "ip" : "ip",
  "phase1_integrity_algorithm" : "SHA1",
  "phase1_lifetime" : "1h",
  "description" : "description",
  "dpd_timeout" : "240s",
  "dpd_timeout_action" : "restart",
  "start_action" : "start",
  "rekey_time" : "2h",
  "remote_ip" : "remote_ip",
  "phase2_lifetime" : "1h",
  "phase2_dh_group_number" : 6,
  "firewall" : {
    "ingress" : [ {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    } ],
    "egress_policy" : "accept",
    "egress" : [ {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    } ]
  },
  "name" : "name",
  "phase2_integrity_algorithm" : "SHA1",
  "remote_subnet" : "remote_subnet",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiApi;

import java.io.File;
import java.util.*;

public class KawaiiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.
        KawaiiIpSec kawaiiIpSec = ; // KawaiiIpSec | 

        try {
            KawaiiIpSec result = apiInstance.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#updateKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final String kawaiiIpSecId = new String(); // String | The ID of the Kawaii IPsec connection.
final KawaiiIpSec kawaiiIpSec = new KawaiiIpSec(); // KawaiiIpSec | 

try {
    final result = await api_instance.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKawaiiIpSec: $e\n');
}

import org.openapitools.client.api.KawaiiApi;

public class KawaiiApiExample {
    public static void main(String[] args) {
        KawaiiApi apiInstance = new KawaiiApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.
        KawaiiIpSec kawaiiIpSec = ; // KawaiiIpSec | 

        try {
            KawaiiIpSec result = apiInstance.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiApi#updateKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiApi *apiInstance = [[KawaiiApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
String *kawaiiIpSecId = kawaiiIpSecId_example; // The ID of the Kawaii IPsec connection. (default to null)
KawaiiIpSec *kawaiiIpSec = ; // 

[apiInstance updateKawaiiIpSecWith:kawaiiId
    kawaiiIpSecId:kawaiiIpSecId
    kawaiiIpSec:kawaiiIpSec
              completionHandler: ^(KawaiiIpSec output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaiiIpSecId = kawaiiIpSecId_example; // {String} The ID of the Kawaii IPsec connection.
var kawaiiIpSec = ; // {KawaiiIpSec} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateKawaiiIpSecExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaiiIpSecId = kawaiiIpSecId_example;  // String | The ID of the Kawaii IPsec connection. (default to null)
            var kawaiiIpSec = new KawaiiIpSec(); // KawaiiIpSec | 

            try {
                KawaiiIpSec result = apiInstance.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiApi.updateKawaiiIpSec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.
$kawaiiIpSec = ; // KawaiiIpSec | 

try {
    $result = $api_instance->updateKawaiiIpSec($kawaiiId, $kawaiiIpSecId, $kawaiiIpSec);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiApi->updateKawaiiIpSec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaiiIpSecId = kawaiiIpSecId_example; # String | The ID of the Kawaii IPsec connection.
my $kawaiiIpSec = WWW::OPenAPIClient::Object::KawaiiIpSec->new(); # KawaiiIpSec | 

eval {
    my $result = $api_instance->updateKawaiiIpSec(kawaiiId => $kawaiiId, kawaiiIpSecId => $kawaiiIpSecId, kawaiiIpSec => $kawaiiIpSec);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiApi->updateKawaiiIpSec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaiiIpSecId = kawaiiIpSecId_example # String | The ID of the Kawaii IPsec connection. (default to null)
kawaiiIpSec =  # KawaiiIpSec | 

try:
    api_response = api_instance.update_kawaii_ip_sec(kawaiiId, kawaiiIpSecId, kawaiiIpSec)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiApi->updateKawaiiIpSec: %s\n" % e)
extern crate KawaiiApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaiiIpSecId = kawaiiIpSecId_example; // String
    let kawaiiIpSec = ; // KawaiiIpSec

    let mut context = KawaiiApi::Context::default();
    let result = client.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
KawaiiIpSecId*
String
The ID of the Kawaii IPsec connection.
Required
Body parameters
Name Description
kawaiiIpSec *

KawaiiIpSec payload.

Responses


KawaiiIpsec

createKawaiiIpSec

Creates a new Kawaii IPsec connection.


/kawaii/{kawaiiId}/ipsec

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec" \
 -d '{
  "pre_shared_key" : "pre_shared_key",
  "phase1_dh_group_number" : 0,
  "phase1_encryption_algorithm" : "AES128",
  "phase2_encryption_algorithm" : "AES128",
  "ip" : "ip",
  "phase1_integrity_algorithm" : "SHA1",
  "phase1_lifetime" : "1h",
  "description" : "description",
  "dpd_timeout" : "240s",
  "dpd_timeout_action" : "restart",
  "start_action" : "start",
  "rekey_time" : "2h",
  "remote_ip" : "remote_ip",
  "phase2_lifetime" : "1h",
  "phase2_dh_group_number" : 6,
  "firewall" : {
    "ingress" : [ {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    } ],
    "egress_policy" : "accept",
    "egress" : [ {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    } ]
  },
  "name" : "name",
  "phase2_integrity_algorithm" : "SHA1",
  "remote_subnet" : "remote_subnet",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiIpsecApi;

import java.io.File;
import java.util.*;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        KawaiiIpSec kawaiiIpSec = ; // KawaiiIpSec | 

        try {
            KawaiiIpSec result = apiInstance.createKawaiiIpSec(kawaiiId, kawaiiIpSec);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#createKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final KawaiiIpSec kawaiiIpSec = new KawaiiIpSec(); // KawaiiIpSec | 

try {
    final result = await api_instance.createKawaiiIpSec(kawaiiId, kawaiiIpSec);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createKawaiiIpSec: $e\n');
}

import org.openapitools.client.api.KawaiiIpsecApi;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        KawaiiIpSec kawaiiIpSec = ; // KawaiiIpSec | 

        try {
            KawaiiIpSec result = apiInstance.createKawaiiIpSec(kawaiiId, kawaiiIpSec);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#createKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiIpsecApi *apiInstance = [[KawaiiIpsecApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
KawaiiIpSec *kawaiiIpSec = ; // 

[apiInstance createKawaiiIpSecWith:kawaiiId
    kawaiiIpSec:kawaiiIpSec
              completionHandler: ^(KawaiiIpSec output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiIpsecApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaiiIpSec = ; // {KawaiiIpSec} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createKawaiiIpSec(kawaiiId, kawaiiIpSec, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createKawaiiIpSecExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiIpsecApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaiiIpSec = new KawaiiIpSec(); // KawaiiIpSec | 

            try {
                KawaiiIpSec result = apiInstance.createKawaiiIpSec(kawaiiId, kawaiiIpSec);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiIpsecApi.createKawaiiIpSec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiIpsecApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaiiIpSec = ; // KawaiiIpSec | 

try {
    $result = $api_instance->createKawaiiIpSec($kawaiiId, $kawaiiIpSec);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiIpsecApi->createKawaiiIpSec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiIpsecApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiIpsecApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaiiIpSec = WWW::OPenAPIClient::Object::KawaiiIpSec->new(); # KawaiiIpSec | 

eval {
    my $result = $api_instance->createKawaiiIpSec(kawaiiId => $kawaiiId, kawaiiIpSec => $kawaiiIpSec);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiIpsecApi->createKawaiiIpSec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiIpsecApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaiiIpSec =  # KawaiiIpSec | 

try:
    api_response = api_instance.create_kawaii_ip_sec(kawaiiId, kawaiiIpSec)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiIpsecApi->createKawaiiIpSec: %s\n" % e)
extern crate KawaiiIpsecApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaiiIpSec = ; // KawaiiIpSec

    let mut context = KawaiiIpsecApi::Context::default();
    let result = client.createKawaiiIpSec(kawaiiId, kawaiiIpSec, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
Body parameters
Name Description
kawaiiIpSec *

KawaiiIpSec payload.

Responses


deleteKawaiiIpSec

Deletes an existing Kawaii IPsec connection.


/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiIpsecApi;

import java.io.File;
import java.util.*;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

        try {
            apiInstance.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#deleteKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final String kawaiiIpSecId = new String(); // String | The ID of the Kawaii IPsec connection.

try {
    final result = await api_instance.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteKawaiiIpSec: $e\n');
}

import org.openapitools.client.api.KawaiiIpsecApi;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

        try {
            apiInstance.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#deleteKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiIpsecApi *apiInstance = [[KawaiiIpsecApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
String *kawaiiIpSecId = kawaiiIpSecId_example; // The ID of the Kawaii IPsec connection. (default to null)

[apiInstance deleteKawaiiIpSecWith:kawaiiId
    kawaiiIpSecId:kawaiiIpSecId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiIpsecApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaiiIpSecId = kawaiiIpSecId_example; // {String} The ID of the Kawaii IPsec connection.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteKawaiiIpSecExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiIpsecApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaiiIpSecId = kawaiiIpSecId_example;  // String | The ID of the Kawaii IPsec connection. (default to null)

            try {
                apiInstance.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiIpsecApi.deleteKawaiiIpSec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiIpsecApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

try {
    $api_instance->deleteKawaiiIpSec($kawaiiId, $kawaiiIpSecId);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiIpsecApi->deleteKawaiiIpSec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiIpsecApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiIpsecApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaiiIpSecId = kawaiiIpSecId_example; # String | The ID of the Kawaii IPsec connection.

eval {
    $api_instance->deleteKawaiiIpSec(kawaiiId => $kawaiiId, kawaiiIpSecId => $kawaiiIpSecId);
};
if ($@) {
    warn "Exception when calling KawaiiIpsecApi->deleteKawaiiIpSec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiIpsecApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaiiIpSecId = kawaiiIpSecId_example # String | The ID of the Kawaii IPsec connection. (default to null)

try:
    api_instance.delete_kawaii_ip_sec(kawaiiId, kawaiiIpSecId)
except ApiException as e:
    print("Exception when calling KawaiiIpsecApi->deleteKawaiiIpSec: %s\n" % e)
extern crate KawaiiIpsecApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaiiIpSecId = kawaiiIpSecId_example; // String

    let mut context = KawaiiIpsecApi::Context::default();
    let result = client.deleteKawaiiIpSec(kawaiiId, kawaiiIpSecId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
KawaiiIpSecId*
String
The ID of the Kawaii IPsec connection.
Required

Responses


listKawaiiIpSecs

Returns the IDs of Kawaii IPsec connection objects.


/kawaii/{kawaiiId}/ipsec

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiIpsecApi;

import java.io.File;
import java.util.*;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

        try {
            array['String'] result = apiInstance.listKawaiiIpSecs(kawaiiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#listKawaiiIpSecs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.

try {
    final result = await api_instance.listKawaiiIpSecs(kawaiiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKawaiiIpSecs: $e\n');
}

import org.openapitools.client.api.KawaiiIpsecApi;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

        try {
            array['String'] result = apiInstance.listKawaiiIpSecs(kawaiiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#listKawaiiIpSecs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiIpsecApi *apiInstance = [[KawaiiIpsecApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)

[apiInstance listKawaiiIpSecsWith:kawaiiId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiIpsecApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKawaiiIpSecs(kawaiiId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKawaiiIpSecsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiIpsecApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)

            try {
                array['String'] result = apiInstance.listKawaiiIpSecs(kawaiiId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiIpsecApi.listKawaiiIpSecs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiIpsecApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.

try {
    $result = $api_instance->listKawaiiIpSecs($kawaiiId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiIpsecApi->listKawaiiIpSecs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiIpsecApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiIpsecApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.

eval {
    my $result = $api_instance->listKawaiiIpSecs(kawaiiId => $kawaiiId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiIpsecApi->listKawaiiIpSecs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiIpsecApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)

try:
    api_response = api_instance.list_kawaii_ip_secs(kawaiiId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiIpsecApi->listKawaiiIpSecs: %s\n" % e)
extern crate KawaiiIpsecApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String

    let mut context = KawaiiIpsecApi::Context::default();
    let result = client.listKawaiiIpSecs(kawaiiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required

Responses


readKawaiiIpSec

Returns a Kawaii IPsec connection.


/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiIpsecApi;

import java.io.File;
import java.util.*;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

        try {
            KawaiiIpSec result = apiInstance.readKawaiiIpSec(kawaiiId, kawaiiIpSecId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#readKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final String kawaiiIpSecId = new String(); // String | The ID of the Kawaii IPsec connection.

try {
    final result = await api_instance.readKawaiiIpSec(kawaiiId, kawaiiIpSecId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKawaiiIpSec: $e\n');
}

import org.openapitools.client.api.KawaiiIpsecApi;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

        try {
            KawaiiIpSec result = apiInstance.readKawaiiIpSec(kawaiiId, kawaiiIpSecId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#readKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiIpsecApi *apiInstance = [[KawaiiIpsecApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
String *kawaiiIpSecId = kawaiiIpSecId_example; // The ID of the Kawaii IPsec connection. (default to null)

[apiInstance readKawaiiIpSecWith:kawaiiId
    kawaiiIpSecId:kawaiiIpSecId
              completionHandler: ^(KawaiiIpSec output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiIpsecApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaiiIpSecId = kawaiiIpSecId_example; // {String} The ID of the Kawaii IPsec connection.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKawaiiIpSec(kawaiiId, kawaiiIpSecId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKawaiiIpSecExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiIpsecApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaiiIpSecId = kawaiiIpSecId_example;  // String | The ID of the Kawaii IPsec connection. (default to null)

            try {
                KawaiiIpSec result = apiInstance.readKawaiiIpSec(kawaiiId, kawaiiIpSecId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiIpsecApi.readKawaiiIpSec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiIpsecApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.

try {
    $result = $api_instance->readKawaiiIpSec($kawaiiId, $kawaiiIpSecId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiIpsecApi->readKawaiiIpSec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiIpsecApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiIpsecApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaiiIpSecId = kawaiiIpSecId_example; # String | The ID of the Kawaii IPsec connection.

eval {
    my $result = $api_instance->readKawaiiIpSec(kawaiiId => $kawaiiId, kawaiiIpSecId => $kawaiiIpSecId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiIpsecApi->readKawaiiIpSec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiIpsecApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaiiIpSecId = kawaiiIpSecId_example # String | The ID of the Kawaii IPsec connection. (default to null)

try:
    api_response = api_instance.read_kawaii_ip_sec(kawaiiId, kawaiiIpSecId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiIpsecApi->readKawaiiIpSec: %s\n" % e)
extern crate KawaiiIpsecApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaiiIpSecId = kawaiiIpSecId_example; // String

    let mut context = KawaiiIpsecApi::Context::default();
    let result = client.readKawaiiIpSec(kawaiiId, kawaiiIpSecId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
KawaiiIpSecId*
String
The ID of the Kawaii IPsec connection.
Required

Responses


updateKawaiiIpSec

Updates a Kawaii IPsec connection configuration.


/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kawaii/{kawaiiId}/ipsec/{KawaiiIpSecId}" \
 -d '{
  "pre_shared_key" : "pre_shared_key",
  "phase1_dh_group_number" : 0,
  "phase1_encryption_algorithm" : "AES128",
  "phase2_encryption_algorithm" : "AES128",
  "ip" : "ip",
  "phase1_integrity_algorithm" : "SHA1",
  "phase1_lifetime" : "1h",
  "description" : "description",
  "dpd_timeout" : "240s",
  "dpd_timeout_action" : "restart",
  "start_action" : "start",
  "rekey_time" : "2h",
  "remote_ip" : "remote_ip",
  "phase2_lifetime" : "1h",
  "phase2_dh_group_number" : 6,
  "firewall" : {
    "ingress" : [ {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    } ],
    "egress_policy" : "accept",
    "egress" : [ {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    } ]
  },
  "name" : "name",
  "phase2_integrity_algorithm" : "SHA1",
  "remote_subnet" : "remote_subnet",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KawaiiIpsecApi;

import java.io.File;
import java.util.*;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.
        KawaiiIpSec kawaiiIpSec = ; // KawaiiIpSec | 

        try {
            KawaiiIpSec result = apiInstance.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#updateKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kawaiiId = new String(); // String | The ID of the Kawaii.
final String kawaiiIpSecId = new String(); // String | The ID of the Kawaii IPsec connection.
final KawaiiIpSec kawaiiIpSec = new KawaiiIpSec(); // KawaiiIpSec | 

try {
    final result = await api_instance.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKawaiiIpSec: $e\n');
}

import org.openapitools.client.api.KawaiiIpsecApi;

public class KawaiiIpsecApiExample {
    public static void main(String[] args) {
        KawaiiIpsecApi apiInstance = new KawaiiIpsecApi();
        String kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
        String kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.
        KawaiiIpSec kawaiiIpSec = ; // KawaiiIpSec | 

        try {
            KawaiiIpSec result = apiInstance.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KawaiiIpsecApi#updateKawaiiIpSec");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KawaiiIpsecApi *apiInstance = [[KawaiiIpsecApi alloc] init];
String *kawaiiId = kawaiiId_example; // The ID of the Kawaii. (default to null)
String *kawaiiIpSecId = kawaiiIpSecId_example; // The ID of the Kawaii IPsec connection. (default to null)
KawaiiIpSec *kawaiiIpSec = ; // 

[apiInstance updateKawaiiIpSecWith:kawaiiId
    kawaiiIpSecId:kawaiiIpSecId
    kawaiiIpSec:kawaiiIpSec
              completionHandler: ^(KawaiiIpSec output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KawaiiIpsecApi()
var kawaiiId = kawaiiId_example; // {String} The ID of the Kawaii.
var kawaiiIpSecId = kawaiiIpSecId_example; // {String} The ID of the Kawaii IPsec connection.
var kawaiiIpSec = ; // {KawaiiIpSec} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateKawaiiIpSecExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KawaiiIpsecApi();
            var kawaiiId = kawaiiId_example;  // String | The ID of the Kawaii. (default to null)
            var kawaiiIpSecId = kawaiiIpSecId_example;  // String | The ID of the Kawaii IPsec connection. (default to null)
            var kawaiiIpSec = new KawaiiIpSec(); // KawaiiIpSec | 

            try {
                KawaiiIpSec result = apiInstance.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KawaiiIpsecApi.updateKawaiiIpSec: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KawaiiIpsecApi();
$kawaiiId = kawaiiId_example; // String | The ID of the Kawaii.
$kawaiiIpSecId = kawaiiIpSecId_example; // String | The ID of the Kawaii IPsec connection.
$kawaiiIpSec = ; // KawaiiIpSec | 

try {
    $result = $api_instance->updateKawaiiIpSec($kawaiiId, $kawaiiIpSecId, $kawaiiIpSec);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KawaiiIpsecApi->updateKawaiiIpSec: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KawaiiIpsecApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KawaiiIpsecApi->new();
my $kawaiiId = kawaiiId_example; # String | The ID of the Kawaii.
my $kawaiiIpSecId = kawaiiIpSecId_example; # String | The ID of the Kawaii IPsec connection.
my $kawaiiIpSec = WWW::OPenAPIClient::Object::KawaiiIpSec->new(); # KawaiiIpSec | 

eval {
    my $result = $api_instance->updateKawaiiIpSec(kawaiiId => $kawaiiId, kawaiiIpSecId => $kawaiiIpSecId, kawaiiIpSec => $kawaiiIpSec);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KawaiiIpsecApi->updateKawaiiIpSec: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KawaiiIpsecApi()
kawaiiId = kawaiiId_example # String | The ID of the Kawaii. (default to null)
kawaiiIpSecId = kawaiiIpSecId_example # String | The ID of the Kawaii IPsec connection. (default to null)
kawaiiIpSec =  # KawaiiIpSec | 

try:
    api_response = api_instance.update_kawaii_ip_sec(kawaiiId, kawaiiIpSecId, kawaiiIpSec)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KawaiiIpsecApi->updateKawaiiIpSec: %s\n" % e)
extern crate KawaiiIpsecApi;

pub fn main() {
    let kawaiiId = kawaiiId_example; // String
    let kawaiiIpSecId = kawaiiIpSecId_example; // String
    let kawaiiIpSec = ; // KawaiiIpSec

    let mut context = KawaiiIpsecApi::Context::default();
    let result = client.updateKawaiiIpSec(kawaiiId, kawaiiIpSecId, kawaiiIpSec, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kawaiiId*
String
The ID of the Kawaii.
Required
KawaiiIpSecId*
String
The ID of the Kawaii IPsec connection.
Required
Body parameters
Name Description
kawaiiIpSec *

KawaiiIpSec payload.

Responses


Kiwi

createKiwi

Creates a new Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..


/region/{regionId}/kiwi

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/kiwi" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KiwiApi;

import java.io.File;
import java.util.*;

public class KiwiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KiwiApi apiInstance = new KiwiApi();
        String regionId = regionId_example; // String | The ID of the region.
        Kiwi kiwi = ; // Kiwi | 

        try {
            Kiwi result = apiInstance.createKiwi(regionId, kiwi);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#createKiwi");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final Kiwi kiwi = new Kiwi(); // Kiwi | 

try {
    final result = await api_instance.createKiwi(regionId, kiwi);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createKiwi: $e\n');
}

import org.openapitools.client.api.KiwiApi;

public class KiwiApiExample {
    public static void main(String[] args) {
        KiwiApi apiInstance = new KiwiApi();
        String regionId = regionId_example; // String | The ID of the region.
        Kiwi kiwi = ; // Kiwi | 

        try {
            Kiwi result = apiInstance.createKiwi(regionId, kiwi);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#createKiwi");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KiwiApi *apiInstance = [[KiwiApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
Kiwi *kiwi = ; // 

[apiInstance createKiwiWith:regionId
    kiwi:kiwi
              completionHandler: ^(Kiwi output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KiwiApi()
var regionId = regionId_example; // {String} The ID of the region.
var kiwi = ; // {Kiwi} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createKiwi(regionId, kiwi, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createKiwiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KiwiApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var kiwi = new Kiwi(); // Kiwi | 

            try {
                Kiwi result = apiInstance.createKiwi(regionId, kiwi);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KiwiApi.createKiwi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KiwiApi();
$regionId = regionId_example; // String | The ID of the region.
$kiwi = ; // Kiwi | 

try {
    $result = $api_instance->createKiwi($regionId, $kiwi);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KiwiApi->createKiwi: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KiwiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KiwiApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $kiwi = WWW::OPenAPIClient::Object::Kiwi->new(); # Kiwi | 

eval {
    my $result = $api_instance->createKiwi(regionId => $regionId, kiwi => $kiwi);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KiwiApi->createKiwi: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KiwiApi()
regionId = regionId_example # String | The ID of the region. (default to null)
kiwi =  # Kiwi | 

try:
    api_response = api_instance.create_kiwi(regionId, kiwi)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KiwiApi->createKiwi: %s\n" % e)
extern crate KiwiApi;

pub fn main() {
    let regionId = regionId_example; // String
    let kiwi = ; // Kiwi

    let mut context = KiwiApi::Context::default();
    let result = client.createKiwi(regionId, kiwi, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
kiwi *

Kiwi payload.

Responses


deleteKiwi

Deletes an existing Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..


/kiwi/{kiwiId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kiwi/{kiwiId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KiwiApi;

import java.io.File;
import java.util.*;

public class KiwiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KiwiApi apiInstance = new KiwiApi();
        String kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

        try {
            apiInstance.deleteKiwi(kiwiId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#deleteKiwi");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kiwiId = new String(); // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

try {
    final result = await api_instance.deleteKiwi(kiwiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteKiwi: $e\n');
}

import org.openapitools.client.api.KiwiApi;

public class KiwiApiExample {
    public static void main(String[] args) {
        KiwiApi apiInstance = new KiwiApi();
        String kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

        try {
            apiInstance.deleteKiwi(kiwiId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#deleteKiwi");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KiwiApi *apiInstance = [[KiwiApi alloc] init];
String *kiwiId = kiwiId_example; // The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)

[apiInstance deleteKiwiWith:kiwiId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KiwiApi()
var kiwiId = kiwiId_example; // {String} The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKiwi(kiwiId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteKiwiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KiwiApi();
            var kiwiId = kiwiId_example;  // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)

            try {
                apiInstance.deleteKiwi(kiwiId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KiwiApi.deleteKiwi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KiwiApi();
$kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

try {
    $api_instance->deleteKiwi($kiwiId);
} catch (Exception $e) {
    echo 'Exception when calling KiwiApi->deleteKiwi: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KiwiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KiwiApi->new();
my $kiwiId = kiwiId_example; # String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

eval {
    $api_instance->deleteKiwi(kiwiId => $kiwiId);
};
if ($@) {
    warn "Exception when calling KiwiApi->deleteKiwi: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KiwiApi()
kiwiId = kiwiId_example # String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)

try:
    api_instance.delete_kiwi(kiwiId)
except ApiException as e:
    print("Exception when calling KiwiApi->deleteKiwi: %s\n" % e)
extern crate KiwiApi;

pub fn main() {
    let kiwiId = kiwiId_example; // String

    let mut context = KiwiApi::Context::default();
    let result = client.deleteKiwi(kiwiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kiwiId*
String
The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
Required

Responses


listKiwis

Returns the IDs of Kiwi (Kowabunga Inner Wan Interface) provides edge-network services. objects.


/kiwi

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kiwi"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KiwiApi;

import java.io.File;
import java.util.*;

public class KiwiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KiwiApi apiInstance = new KiwiApi();

        try {
            array['String'] result = apiInstance.listKiwis();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#listKiwis");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listKiwis();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKiwis: $e\n');
}

import org.openapitools.client.api.KiwiApi;

public class KiwiApiExample {
    public static void main(String[] args) {
        KiwiApi apiInstance = new KiwiApi();

        try {
            array['String'] result = apiInstance.listKiwis();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#listKiwis");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KiwiApi *apiInstance = [[KiwiApi alloc] init];

[apiInstance listKiwisWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KiwiApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKiwis(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKiwisExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KiwiApi();

            try {
                array['String'] result = apiInstance.listKiwis();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KiwiApi.listKiwis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KiwiApi();

try {
    $result = $api_instance->listKiwis();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KiwiApi->listKiwis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KiwiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KiwiApi->new();

eval {
    my $result = $api_instance->listKiwis();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KiwiApi->listKiwis: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KiwiApi()

try:
    api_response = api_instance.list_kiwis()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KiwiApi->listKiwis: %s\n" % e)
extern crate KiwiApi;

pub fn main() {

    let mut context = KiwiApi::Context::default();
    let result = client.listKiwis(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listRegionKiwis

Returns the IDs of Kiwi (Kowabunga Inner Wan Interface) provides edge-network services. objects.


/region/{regionId}/kiwis

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/kiwis"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KiwiApi;

import java.io.File;
import java.util.*;

public class KiwiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KiwiApi apiInstance = new KiwiApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionKiwis(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#listRegionKiwis");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listRegionKiwis(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionKiwis: $e\n');
}

import org.openapitools.client.api.KiwiApi;

public class KiwiApiExample {
    public static void main(String[] args) {
        KiwiApi apiInstance = new KiwiApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionKiwis(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#listRegionKiwis");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KiwiApi *apiInstance = [[KiwiApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listRegionKiwisWith:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KiwiApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionKiwis(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionKiwisExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KiwiApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listRegionKiwis(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KiwiApi.listRegionKiwis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KiwiApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listRegionKiwis($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KiwiApi->listRegionKiwis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KiwiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KiwiApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listRegionKiwis(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KiwiApi->listRegionKiwis: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KiwiApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_region_kiwis(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KiwiApi->listRegionKiwis: %s\n" % e)
extern crate KiwiApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = KiwiApi::Context::default();
    let result = client.listRegionKiwis(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


readKiwi

Returns a Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..


/kiwi/{kiwiId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kiwi/{kiwiId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KiwiApi;

import java.io.File;
import java.util.*;

public class KiwiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KiwiApi apiInstance = new KiwiApi();
        String kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

        try {
            Kiwi result = apiInstance.readKiwi(kiwiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#readKiwi");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kiwiId = new String(); // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

try {
    final result = await api_instance.readKiwi(kiwiId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKiwi: $e\n');
}

import org.openapitools.client.api.KiwiApi;

public class KiwiApiExample {
    public static void main(String[] args) {
        KiwiApi apiInstance = new KiwiApi();
        String kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

        try {
            Kiwi result = apiInstance.readKiwi(kiwiId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#readKiwi");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KiwiApi *apiInstance = [[KiwiApi alloc] init];
String *kiwiId = kiwiId_example; // The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)

[apiInstance readKiwiWith:kiwiId
              completionHandler: ^(Kiwi output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KiwiApi()
var kiwiId = kiwiId_example; // {String} The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKiwi(kiwiId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKiwiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KiwiApi();
            var kiwiId = kiwiId_example;  // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)

            try {
                Kiwi result = apiInstance.readKiwi(kiwiId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KiwiApi.readKiwi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KiwiApi();
$kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

try {
    $result = $api_instance->readKiwi($kiwiId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KiwiApi->readKiwi: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KiwiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KiwiApi->new();
my $kiwiId = kiwiId_example; # String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..

eval {
    my $result = $api_instance->readKiwi(kiwiId => $kiwiId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KiwiApi->readKiwi: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KiwiApi()
kiwiId = kiwiId_example # String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)

try:
    api_response = api_instance.read_kiwi(kiwiId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KiwiApi->readKiwi: %s\n" % e)
extern crate KiwiApi;

pub fn main() {
    let kiwiId = kiwiId_example; // String

    let mut context = KiwiApi::Context::default();
    let result = client.readKiwi(kiwiId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kiwiId*
String
The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
Required

Responses


updateKiwi

Updates a Kiwi (Kowabunga Inner Wan Interface) provides edge-network services. configuration.


/kiwi/{kiwiId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kiwi/{kiwiId}" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KiwiApi;

import java.io.File;
import java.util.*;

public class KiwiApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KiwiApi apiInstance = new KiwiApi();
        String kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
        Kiwi kiwi = ; // Kiwi | 

        try {
            Kiwi result = apiInstance.updateKiwi(kiwiId, kiwi);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#updateKiwi");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kiwiId = new String(); // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
final Kiwi kiwi = new Kiwi(); // Kiwi | 

try {
    final result = await api_instance.updateKiwi(kiwiId, kiwi);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKiwi: $e\n');
}

import org.openapitools.client.api.KiwiApi;

public class KiwiApiExample {
    public static void main(String[] args) {
        KiwiApi apiInstance = new KiwiApi();
        String kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
        Kiwi kiwi = ; // Kiwi | 

        try {
            Kiwi result = apiInstance.updateKiwi(kiwiId, kiwi);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KiwiApi#updateKiwi");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KiwiApi *apiInstance = [[KiwiApi alloc] init];
String *kiwiId = kiwiId_example; // The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)
Kiwi *kiwi = ; // 

[apiInstance updateKiwiWith:kiwiId
    kiwi:kiwi
              completionHandler: ^(Kiwi output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KiwiApi()
var kiwiId = kiwiId_example; // {String} The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
var kiwi = ; // {Kiwi} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKiwi(kiwiId, kiwi, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateKiwiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KiwiApi();
            var kiwiId = kiwiId_example;  // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)
            var kiwi = new Kiwi(); // Kiwi | 

            try {
                Kiwi result = apiInstance.updateKiwi(kiwiId, kiwi);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KiwiApi.updateKiwi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KiwiApi();
$kiwiId = kiwiId_example; // String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
$kiwi = ; // Kiwi | 

try {
    $result = $api_instance->updateKiwi($kiwiId, $kiwi);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KiwiApi->updateKiwi: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KiwiApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KiwiApi->new();
my $kiwiId = kiwiId_example; # String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
my $kiwi = WWW::OPenAPIClient::Object::Kiwi->new(); # Kiwi | 

eval {
    my $result = $api_instance->updateKiwi(kiwiId => $kiwiId, kiwi => $kiwi);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KiwiApi->updateKiwi: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KiwiApi()
kiwiId = kiwiId_example # String | The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services.. (default to null)
kiwi =  # Kiwi | 

try:
    api_response = api_instance.update_kiwi(kiwiId, kiwi)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KiwiApi->updateKiwi: %s\n" % e)
extern crate KiwiApi;

pub fn main() {
    let kiwiId = kiwiId_example; // String
    let kiwi = ; // Kiwi

    let mut context = KiwiApi::Context::default();
    let result = client.updateKiwi(kiwiId, kiwi, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kiwiId*
String
The ID of the Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..
Required
Body parameters
Name Description
kiwi *

Kiwi payload.

Responses


Kompute

createProjectZoneKompute

Creates a new Kompute.


/project/{projectId}/zone/{zoneId}/kompute

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/kompute?poolId=poolId_example&templateId=templateId_example&public=true" \
 -d '{
  "disk" : 1,
  "data_disk" : 5,
  "memory" : 0,
  "ip" : "ip",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vcpus" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kompute kompute = ; // Kompute | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
        Boolean public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

        try {
            Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#createProjectZoneKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Kompute kompute = new Kompute(); // Kompute | 
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).
final String templateId = new String(); // String | Template to clone the storage volume from (optional, region's default if unspecified).
final Boolean public = new Boolean(); // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

try {
    final result = await api_instance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kompute kompute = ; // Kompute | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
        Boolean public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

        try {
            Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#createProjectZoneKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Kompute *kompute = ; // 
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
String *templateId = templateId_example; // Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)
Boolean *public = true; // Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional) (default to null)

[apiInstance createProjectZoneKomputeWith:projectId
    zoneId:zoneId
    kompute:kompute
    poolId:poolId
    templateId:templateId
    public:public
              completionHandler: ^(Kompute output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var kompute = ; // {Kompute} 
var opts = {
  'poolId': poolId_example, // {String} Storage pool ID (optional, region's default if unspecified).
  'templateId': templateId_example, // {String} Template to clone the storage volume from (optional, region's default if unspecified).
  'public': true // {Boolean} Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneKompute(projectId, zoneId, kompute, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var kompute = new Kompute(); // Kompute | 
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)
            var templateId = templateId_example;  // String | Template to clone the storage volume from (optional, region's default if unspecified). (optional)  (default to null)
            var public = true;  // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional)  (default to null)

            try {
                Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.createProjectZoneKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$kompute = ; // Kompute | 
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
$templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
$public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

try {
    $result = $api_instance->createProjectZoneKompute($projectId, $zoneId, $kompute, $poolId, $templateId, $public);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->createProjectZoneKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $kompute = WWW::OPenAPIClient::Object::Kompute->new(); # Kompute | 
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).
my $templateId = templateId_example; # String | Template to clone the storage volume from (optional, region's default if unspecified).
my $public = true; # Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

eval {
    my $result = $api_instance->createProjectZoneKompute(projectId => $projectId, zoneId => $zoneId, kompute => $kompute, poolId => $poolId, templateId => $templateId, public => $public);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KomputeApi->createProjectZoneKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
kompute =  # Kompute | 
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
templateId = templateId_example # String | Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)
public = true # Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional) (default to null)

try:
    api_response = api_instance.create_project_zone_kompute(projectId, zoneId, kompute, poolId=poolId, templateId=templateId, public=public)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KomputeApi->createProjectZoneKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let kompute = ; // Kompute
    let poolId = poolId_example; // String
    let templateId = templateId_example; // String
    let public = true; // Boolean

    let mut context = KomputeApi::Context::default();
    let result = client.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
kompute *

Kompute payload.

Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).
templateId
String
Template to clone the storage volume from (optional, region's default if unspecified).
public
Boolean
Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

Responses


deleteKompute

Deletes an existing Kompute.


/kompute/{komputeId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.deleteKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#deleteKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.deleteKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.deleteKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#deleteKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance deleteKomputeWith:komputeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                apiInstance.deleteKompute(komputeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.deleteKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $api_instance->deleteKompute($komputeId);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->deleteKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    $api_instance->deleteKompute(komputeId => $komputeId);
};
if ($@) {
    warn "Exception when calling KomputeApi->deleteKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_instance.delete_kompute(komputeId)
except ApiException as e:
    print("Exception when calling KomputeApi->deleteKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.deleteKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


listKomputes

Returns the IDs of Kompute objects.


/kompute

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();

        try {
            array['String'] result = apiInstance.listKomputes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#listKomputes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listKomputes();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKomputes: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();

        try {
            array['String'] result = apiInstance.listKomputes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#listKomputes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];

[apiInstance listKomputesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKomputes(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKomputesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();

            try {
                array['String'] result = apiInstance.listKomputes();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.listKomputes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();

try {
    $result = $api_instance->listKomputes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->listKomputes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();

eval {
    my $result = $api_instance->listKomputes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KomputeApi->listKomputes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()

try:
    api_response = api_instance.list_komputes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KomputeApi->listKomputes: %s\n" % e)
extern crate KomputeApi;

pub fn main() {

    let mut context = KomputeApi::Context::default();
    let result = client.listKomputes(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listProjectZoneKomputes

Returns the IDs of Kompute objects.


/project/{projectId}/zone/{zoneId}/komputes

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/komputes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#listProjectZoneKomputes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneKomputes(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneKomputes: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#listProjectZoneKomputes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneKomputesWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneKomputes(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneKomputesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.listProjectZoneKomputes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneKomputes($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->listProjectZoneKomputes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneKomputes(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KomputeApi->listProjectZoneKomputes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_komputes(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KomputeApi->listProjectZoneKomputes: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.listProjectZoneKomputes(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


readKompute

Returns a Kompute.


/kompute/{komputeId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            Kompute result = apiInstance.readKompute(komputeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#readKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.readKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            Kompute result = apiInstance.readKompute(komputeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#readKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance readKomputeWith:komputeId
              completionHandler: ^(Kompute output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                Kompute result = apiInstance.readKompute(komputeId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.readKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $result = $api_instance->readKompute($komputeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->readKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    my $result = $api_instance->readKompute(komputeId => $komputeId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KomputeApi->readKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_response = api_instance.read_kompute(komputeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KomputeApi->readKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.readKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


readKomputeState

Returns a virtual machine instance state.


/kompute/{komputeId}/state

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}/state"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            InstanceState result = apiInstance.readKomputeState(komputeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#readKomputeState");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.readKomputeState(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKomputeState: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            InstanceState result = apiInstance.readKomputeState(komputeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#readKomputeState");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance readKomputeStateWith:komputeId
              completionHandler: ^(InstanceState output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKomputeState(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKomputeStateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                InstanceState result = apiInstance.readKomputeState(komputeId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.readKomputeState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $result = $api_instance->readKomputeState($komputeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->readKomputeState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    my $result = $api_instance->readKomputeState(komputeId => $komputeId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KomputeApi->readKomputeState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_response = api_instance.read_kompute_state(komputeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KomputeApi->readKomputeState: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.readKomputeState(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


rebootKompute

Performs a Kompute software reboot.


/kompute/{komputeId}/reboot

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}/reboot"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.rebootKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#rebootKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.rebootKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->rebootKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.rebootKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#rebootKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance rebootKomputeWith:komputeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.rebootKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class rebootKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                apiInstance.rebootKompute(komputeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.rebootKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $api_instance->rebootKompute($komputeId);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->rebootKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    $api_instance->rebootKompute(komputeId => $komputeId);
};
if ($@) {
    warn "Exception when calling KomputeApi->rebootKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_instance.reboot_kompute(komputeId)
except ApiException as e:
    print("Exception when calling KomputeApi->rebootKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.rebootKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


resetKompute

Performs a Kompute hardware reset.


/kompute/{komputeId}/reset

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}/reset"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.resetKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#resetKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.resetKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resetKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.resetKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#resetKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance resetKomputeWith:komputeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class resetKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                apiInstance.resetKompute(komputeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.resetKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $api_instance->resetKompute($komputeId);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->resetKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    $api_instance->resetKompute(komputeId => $komputeId);
};
if ($@) {
    warn "Exception when calling KomputeApi->resetKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_instance.reset_kompute(komputeId)
except ApiException as e:
    print("Exception when calling KomputeApi->resetKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.resetKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


resumeKompute

Performs a Kompute software PM resume.


/kompute/{komputeId}/resume

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}/resume"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.resumeKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#resumeKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.resumeKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resumeKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.resumeKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#resumeKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance resumeKomputeWith:komputeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resumeKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class resumeKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                apiInstance.resumeKompute(komputeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.resumeKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $api_instance->resumeKompute($komputeId);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->resumeKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    $api_instance->resumeKompute(komputeId => $komputeId);
};
if ($@) {
    warn "Exception when calling KomputeApi->resumeKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_instance.resume_kompute(komputeId)
except ApiException as e:
    print("Exception when calling KomputeApi->resumeKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.resumeKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


shutdownKompute

Performs a Kompute software shutdown.


/kompute/{komputeId}/shutdown

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}/shutdown"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.shutdownKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#shutdownKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.shutdownKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->shutdownKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.shutdownKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#shutdownKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance shutdownKomputeWith:komputeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.shutdownKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class shutdownKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                apiInstance.shutdownKompute(komputeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.shutdownKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $api_instance->shutdownKompute($komputeId);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->shutdownKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    $api_instance->shutdownKompute(komputeId => $komputeId);
};
if ($@) {
    warn "Exception when calling KomputeApi->shutdownKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_instance.shutdown_kompute(komputeId)
except ApiException as e:
    print("Exception when calling KomputeApi->shutdownKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.shutdownKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


startKompute

Performs a Kompute hardware boot-up.


/kompute/{komputeId}/start

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}/start"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.startKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#startKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.startKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->startKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.startKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#startKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance startKomputeWith:komputeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.startKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class startKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                apiInstance.startKompute(komputeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.startKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $api_instance->startKompute($komputeId);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->startKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    $api_instance->startKompute(komputeId => $komputeId);
};
if ($@) {
    warn "Exception when calling KomputeApi->startKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_instance.start_kompute(komputeId)
except ApiException as e:
    print("Exception when calling KomputeApi->startKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.startKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


stopKompute

Performs a Kompute hardware stop.


/kompute/{komputeId}/stop

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}/stop"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.stopKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#stopKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.stopKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->stopKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.stopKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#stopKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance stopKomputeWith:komputeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.stopKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class stopKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                apiInstance.stopKompute(komputeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.stopKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $api_instance->stopKompute($komputeId);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->stopKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    $api_instance->stopKompute(komputeId => $komputeId);
};
if ($@) {
    warn "Exception when calling KomputeApi->stopKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_instance.stop_kompute(komputeId)
except ApiException as e:
    print("Exception when calling KomputeApi->stopKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.stopKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


suspendKompute

Performs a Kompute software PM suspend.


/kompute/{komputeId}/suspend

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kompute/{komputeId}/suspend"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.suspendKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#suspendKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.

try {
    final result = await api_instance.suspendKompute(komputeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->suspendKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.

        try {
            apiInstance.suspendKompute(komputeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#suspendKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)

[apiInstance suspendKomputeWith:komputeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.suspendKompute(komputeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class suspendKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)

            try {
                apiInstance.suspendKompute(komputeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.suspendKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.

try {
    $api_instance->suspendKompute($komputeId);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->suspendKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.

eval {
    $api_instance->suspendKompute(komputeId => $komputeId);
};
if ($@) {
    warn "Exception when calling KomputeApi->suspendKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)

try:
    api_instance.suspend_kompute(komputeId)
except ApiException as e:
    print("Exception when calling KomputeApi->suspendKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String

    let mut context = KomputeApi::Context::default();
    let result = client.suspendKompute(komputeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required

Responses


updateKompute

Updates a Kompute configuration.


/kompute/{komputeId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kompute/{komputeId}" \
 -d '{
  "disk" : 1,
  "data_disk" : 5,
  "memory" : 0,
  "ip" : "ip",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vcpus" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KomputeApi;

import java.io.File;
import java.util.*;

public class KomputeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.
        Kompute kompute = ; // Kompute | 

        try {
            Kompute result = apiInstance.updateKompute(komputeId, kompute);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#updateKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String komputeId = new String(); // String | The ID of the Kompute.
final Kompute kompute = new Kompute(); // Kompute | 

try {
    final result = await api_instance.updateKompute(komputeId, kompute);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKompute: $e\n');
}

import org.openapitools.client.api.KomputeApi;

public class KomputeApiExample {
    public static void main(String[] args) {
        KomputeApi apiInstance = new KomputeApi();
        String komputeId = komputeId_example; // String | The ID of the Kompute.
        Kompute kompute = ; // Kompute | 

        try {
            Kompute result = apiInstance.updateKompute(komputeId, kompute);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KomputeApi#updateKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KomputeApi *apiInstance = [[KomputeApi alloc] init];
String *komputeId = komputeId_example; // The ID of the Kompute. (default to null)
Kompute *kompute = ; // 

[apiInstance updateKomputeWith:komputeId
    kompute:kompute
              completionHandler: ^(Kompute output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KomputeApi()
var komputeId = komputeId_example; // {String} The ID of the Kompute.
var kompute = ; // {Kompute} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKompute(komputeId, kompute, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KomputeApi();
            var komputeId = komputeId_example;  // String | The ID of the Kompute. (default to null)
            var kompute = new Kompute(); // Kompute | 

            try {
                Kompute result = apiInstance.updateKompute(komputeId, kompute);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KomputeApi.updateKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KomputeApi();
$komputeId = komputeId_example; // String | The ID of the Kompute.
$kompute = ; // Kompute | 

try {
    $result = $api_instance->updateKompute($komputeId, $kompute);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KomputeApi->updateKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KomputeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KomputeApi->new();
my $komputeId = komputeId_example; # String | The ID of the Kompute.
my $kompute = WWW::OPenAPIClient::Object::Kompute->new(); # Kompute | 

eval {
    my $result = $api_instance->updateKompute(komputeId => $komputeId, kompute => $kompute);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KomputeApi->updateKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KomputeApi()
komputeId = komputeId_example # String | The ID of the Kompute. (default to null)
kompute =  # Kompute | 

try:
    api_response = api_instance.update_kompute(komputeId, kompute)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KomputeApi->updateKompute: %s\n" % e)
extern crate KomputeApi;

pub fn main() {
    let komputeId = komputeId_example; // String
    let kompute = ; // Kompute

    let mut context = KomputeApi::Context::default();
    let result = client.updateKompute(komputeId, kompute, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
komputeId*
String
The ID of the Kompute.
Required
Body parameters
Name Description
kompute *

Kompute payload.

Responses


Konvey

createProjectRegionKonvey

Creates a new Konvey (Kowabunga Network Load-Balancer).


/project/{projectId}/region/{regionId}/konvey

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/konvey" \
 -d '{
  "endpoints" : [ {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  }, {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  } ],
  "failover" : true,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vip" : "vip"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KonveyApi;

import java.io.File;
import java.util.*;

public class KonveyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KonveyApi apiInstance = new KonveyApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#createProjectRegionKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Konvey konvey = new Konvey(); // Konvey | 

try {
    final result = await api_instance.createProjectRegionKonvey(projectId, regionId, konvey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKonvey: $e\n');
}

import org.openapitools.client.api.KonveyApi;

public class KonveyApiExample {
    public static void main(String[] args) {
        KonveyApi apiInstance = new KonveyApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#createProjectRegionKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KonveyApi *apiInstance = [[KonveyApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Konvey *konvey = ; // 

[apiInstance createProjectRegionKonveyWith:projectId
    regionId:regionId
    konvey:konvey
              completionHandler: ^(Konvey output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KonveyApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var konvey = ; // {Konvey} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKonvey(projectId, regionId, konvey, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KonveyApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var konvey = new Konvey(); // Konvey | 

            try {
                Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KonveyApi.createProjectRegionKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KonveyApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$konvey = ; // Konvey | 

try {
    $result = $api_instance->createProjectRegionKonvey($projectId, $regionId, $konvey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KonveyApi->createProjectRegionKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KonveyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KonveyApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $konvey = WWW::OPenAPIClient::Object::Konvey->new(); # Konvey | 

eval {
    my $result = $api_instance->createProjectRegionKonvey(projectId => $projectId, regionId => $regionId, konvey => $konvey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KonveyApi->createProjectRegionKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KonveyApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
konvey =  # Konvey | 

try:
    api_response = api_instance.create_project_region_konvey(projectId, regionId, konvey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KonveyApi->createProjectRegionKonvey: %s\n" % e)
extern crate KonveyApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let konvey = ; // Konvey

    let mut context = KonveyApi::Context::default();
    let result = client.createProjectRegionKonvey(projectId, regionId, konvey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
konvey *

Konvey payload.

Responses


createProjectZoneKonvey

Creates a new Konvey (Kowabunga Network Load-Balancer).


/project/{projectId}/zone/{zoneId}/konvey

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/konvey" \
 -d '{
  "endpoints" : [ {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  }, {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  } ],
  "failover" : true,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vip" : "vip"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KonveyApi;

import java.io.File;
import java.util.*;

public class KonveyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KonveyApi apiInstance = new KonveyApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#createProjectZoneKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Konvey konvey = new Konvey(); // Konvey | 

try {
    final result = await api_instance.createProjectZoneKonvey(projectId, zoneId, konvey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneKonvey: $e\n');
}

import org.openapitools.client.api.KonveyApi;

public class KonveyApiExample {
    public static void main(String[] args) {
        KonveyApi apiInstance = new KonveyApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#createProjectZoneKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KonveyApi *apiInstance = [[KonveyApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Konvey *konvey = ; // 

[apiInstance createProjectZoneKonveyWith:projectId
    zoneId:zoneId
    konvey:konvey
              completionHandler: ^(Konvey output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KonveyApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var konvey = ; // {Konvey} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneKonvey(projectId, zoneId, konvey, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KonveyApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var konvey = new Konvey(); // Konvey | 

            try {
                Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KonveyApi.createProjectZoneKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KonveyApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$konvey = ; // Konvey | 

try {
    $result = $api_instance->createProjectZoneKonvey($projectId, $zoneId, $konvey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KonveyApi->createProjectZoneKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KonveyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KonveyApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $konvey = WWW::OPenAPIClient::Object::Konvey->new(); # Konvey | 

eval {
    my $result = $api_instance->createProjectZoneKonvey(projectId => $projectId, zoneId => $zoneId, konvey => $konvey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KonveyApi->createProjectZoneKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KonveyApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
konvey =  # Konvey | 

try:
    api_response = api_instance.create_project_zone_konvey(projectId, zoneId, konvey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KonveyApi->createProjectZoneKonvey: %s\n" % e)
extern crate KonveyApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let konvey = ; // Konvey

    let mut context = KonveyApi::Context::default();
    let result = client.createProjectZoneKonvey(projectId, zoneId, konvey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
konvey *

Konvey payload.

Responses


deleteKonvey

Deletes an existing Konvey (Kowabunga Network Load-Balancer).


/konvey/{konveyId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/konvey/{konveyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KonveyApi;

import java.io.File;
import java.util.*;

public class KonveyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KonveyApi apiInstance = new KonveyApi();
        String konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).

        try {
            apiInstance.deleteKonvey(konveyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#deleteKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String konveyId = new String(); // String | The ID of the Konvey (Kowabunga Network Load-Balancer).

try {
    final result = await api_instance.deleteKonvey(konveyId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteKonvey: $e\n');
}

import org.openapitools.client.api.KonveyApi;

public class KonveyApiExample {
    public static void main(String[] args) {
        KonveyApi apiInstance = new KonveyApi();
        String konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).

        try {
            apiInstance.deleteKonvey(konveyId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#deleteKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KonveyApi *apiInstance = [[KonveyApi alloc] init];
String *konveyId = konveyId_example; // The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)

[apiInstance deleteKonveyWith:konveyId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KonveyApi()
var konveyId = konveyId_example; // {String} The ID of the Konvey (Kowabunga Network Load-Balancer).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKonvey(konveyId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KonveyApi();
            var konveyId = konveyId_example;  // String | The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)

            try {
                apiInstance.deleteKonvey(konveyId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KonveyApi.deleteKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KonveyApi();
$konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).

try {
    $api_instance->deleteKonvey($konveyId);
} catch (Exception $e) {
    echo 'Exception when calling KonveyApi->deleteKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KonveyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KonveyApi->new();
my $konveyId = konveyId_example; # String | The ID of the Konvey (Kowabunga Network Load-Balancer).

eval {
    $api_instance->deleteKonvey(konveyId => $konveyId);
};
if ($@) {
    warn "Exception when calling KonveyApi->deleteKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KonveyApi()
konveyId = konveyId_example # String | The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)

try:
    api_instance.delete_konvey(konveyId)
except ApiException as e:
    print("Exception when calling KonveyApi->deleteKonvey: %s\n" % e)
extern crate KonveyApi;

pub fn main() {
    let konveyId = konveyId_example; // String

    let mut context = KonveyApi::Context::default();
    let result = client.deleteKonvey(konveyId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
konveyId*
String
The ID of the Konvey (Kowabunga Network Load-Balancer).
Required

Responses


listKonveys

Returns the IDs of Konvey (Kowabunga Network Load-Balancer) objects.


/konvey

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/konvey"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KonveyApi;

import java.io.File;
import java.util.*;

public class KonveyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KonveyApi apiInstance = new KonveyApi();

        try {
            array['String'] result = apiInstance.listKonveys();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#listKonveys");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listKonveys();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKonveys: $e\n');
}

import org.openapitools.client.api.KonveyApi;

public class KonveyApiExample {
    public static void main(String[] args) {
        KonveyApi apiInstance = new KonveyApi();

        try {
            array['String'] result = apiInstance.listKonveys();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#listKonveys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KonveyApi *apiInstance = [[KonveyApi alloc] init];

[apiInstance listKonveysWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KonveyApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKonveys(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKonveysExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KonveyApi();

            try {
                array['String'] result = apiInstance.listKonveys();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KonveyApi.listKonveys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KonveyApi();

try {
    $result = $api_instance->listKonveys();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KonveyApi->listKonveys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KonveyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KonveyApi->new();

eval {
    my $result = $api_instance->listKonveys();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KonveyApi->listKonveys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KonveyApi()

try:
    api_response = api_instance.list_konveys()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KonveyApi->listKonveys: %s\n" % e)
extern crate KonveyApi;

pub fn main() {

    let mut context = KonveyApi::Context::default();
    let result = client.listKonveys(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listProjectRegionKonveys

Returns the IDs of Konvey (Kowabunga Network Load-Balancer) objects.


/project/{projectId}/region/{regionId}/konveys

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/konveys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KonveyApi;

import java.io.File;
import java.util.*;

public class KonveyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KonveyApi apiInstance = new KonveyApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#listProjectRegionKonveys");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionKonveys(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKonveys: $e\n');
}

import org.openapitools.client.api.KonveyApi;

public class KonveyApiExample {
    public static void main(String[] args) {
        KonveyApi apiInstance = new KonveyApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#listProjectRegionKonveys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KonveyApi *apiInstance = [[KonveyApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionKonveysWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KonveyApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKonveys(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKonveysExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KonveyApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KonveyApi.listProjectRegionKonveys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KonveyApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionKonveys($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KonveyApi->listProjectRegionKonveys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KonveyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KonveyApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionKonveys(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KonveyApi->listProjectRegionKonveys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KonveyApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_konveys(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KonveyApi->listProjectRegionKonveys: %s\n" % e)
extern crate KonveyApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = KonveyApi::Context::default();
    let result = client.listProjectRegionKonveys(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


listProjectZoneKonveys

Returns the IDs of Konvey (Kowabunga Network Load-Balancer) objects.


/project/{projectId}/zone/{zoneId}/konveys

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/konveys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KonveyApi;

import java.io.File;
import java.util.*;

public class KonveyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KonveyApi apiInstance = new KonveyApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#listProjectZoneKonveys");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneKonveys(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneKonveys: $e\n');
}

import org.openapitools.client.api.KonveyApi;

public class KonveyApiExample {
    public static void main(String[] args) {
        KonveyApi apiInstance = new KonveyApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#listProjectZoneKonveys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KonveyApi *apiInstance = [[KonveyApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneKonveysWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KonveyApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneKonveys(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneKonveysExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KonveyApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KonveyApi.listProjectZoneKonveys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KonveyApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneKonveys($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KonveyApi->listProjectZoneKonveys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KonveyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KonveyApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneKonveys(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KonveyApi->listProjectZoneKonveys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KonveyApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_konveys(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KonveyApi->listProjectZoneKonveys: %s\n" % e)
extern crate KonveyApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = KonveyApi::Context::default();
    let result = client.listProjectZoneKonveys(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


readKonvey

Returns a Konvey (Kowabunga Network Load-Balancer).


/konvey/{konveyId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/konvey/{konveyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KonveyApi;

import java.io.File;
import java.util.*;

public class KonveyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KonveyApi apiInstance = new KonveyApi();
        String konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).

        try {
            Konvey result = apiInstance.readKonvey(konveyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#readKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String konveyId = new String(); // String | The ID of the Konvey (Kowabunga Network Load-Balancer).

try {
    final result = await api_instance.readKonvey(konveyId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKonvey: $e\n');
}

import org.openapitools.client.api.KonveyApi;

public class KonveyApiExample {
    public static void main(String[] args) {
        KonveyApi apiInstance = new KonveyApi();
        String konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).

        try {
            Konvey result = apiInstance.readKonvey(konveyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#readKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KonveyApi *apiInstance = [[KonveyApi alloc] init];
String *konveyId = konveyId_example; // The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)

[apiInstance readKonveyWith:konveyId
              completionHandler: ^(Konvey output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KonveyApi()
var konveyId = konveyId_example; // {String} The ID of the Konvey (Kowabunga Network Load-Balancer).

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKonvey(konveyId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KonveyApi();
            var konveyId = konveyId_example;  // String | The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)

            try {
                Konvey result = apiInstance.readKonvey(konveyId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KonveyApi.readKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KonveyApi();
$konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).

try {
    $result = $api_instance->readKonvey($konveyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KonveyApi->readKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KonveyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KonveyApi->new();
my $konveyId = konveyId_example; # String | The ID of the Konvey (Kowabunga Network Load-Balancer).

eval {
    my $result = $api_instance->readKonvey(konveyId => $konveyId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KonveyApi->readKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KonveyApi()
konveyId = konveyId_example # String | The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)

try:
    api_response = api_instance.read_konvey(konveyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KonveyApi->readKonvey: %s\n" % e)
extern crate KonveyApi;

pub fn main() {
    let konveyId = konveyId_example; // String

    let mut context = KonveyApi::Context::default();
    let result = client.readKonvey(konveyId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
konveyId*
String
The ID of the Konvey (Kowabunga Network Load-Balancer).
Required

Responses


updateKonvey

Updates a Konvey (Kowabunga Network Load-Balancer) configuration.


/konvey/{konveyId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/konvey/{konveyId}" \
 -d '{
  "endpoints" : [ {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  }, {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  } ],
  "failover" : true,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vip" : "vip"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KonveyApi;

import java.io.File;
import java.util.*;

public class KonveyApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KonveyApi apiInstance = new KonveyApi();
        String konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.updateKonvey(konveyId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#updateKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String konveyId = new String(); // String | The ID of the Konvey (Kowabunga Network Load-Balancer).
final Konvey konvey = new Konvey(); // Konvey | 

try {
    final result = await api_instance.updateKonvey(konveyId, konvey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKonvey: $e\n');
}

import org.openapitools.client.api.KonveyApi;

public class KonveyApiExample {
    public static void main(String[] args) {
        KonveyApi apiInstance = new KonveyApi();
        String konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.updateKonvey(konveyId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KonveyApi#updateKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KonveyApi *apiInstance = [[KonveyApi alloc] init];
String *konveyId = konveyId_example; // The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)
Konvey *konvey = ; // 

[apiInstance updateKonveyWith:konveyId
    konvey:konvey
              completionHandler: ^(Konvey output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KonveyApi()
var konveyId = konveyId_example; // {String} The ID of the Konvey (Kowabunga Network Load-Balancer).
var konvey = ; // {Konvey} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKonvey(konveyId, konvey, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KonveyApi();
            var konveyId = konveyId_example;  // String | The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)
            var konvey = new Konvey(); // Konvey | 

            try {
                Konvey result = apiInstance.updateKonvey(konveyId, konvey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KonveyApi.updateKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KonveyApi();
$konveyId = konveyId_example; // String | The ID of the Konvey (Kowabunga Network Load-Balancer).
$konvey = ; // Konvey | 

try {
    $result = $api_instance->updateKonvey($konveyId, $konvey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KonveyApi->updateKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KonveyApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KonveyApi->new();
my $konveyId = konveyId_example; # String | The ID of the Konvey (Kowabunga Network Load-Balancer).
my $konvey = WWW::OPenAPIClient::Object::Konvey->new(); # Konvey | 

eval {
    my $result = $api_instance->updateKonvey(konveyId => $konveyId, konvey => $konvey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KonveyApi->updateKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KonveyApi()
konveyId = konveyId_example # String | The ID of the Konvey (Kowabunga Network Load-Balancer). (default to null)
konvey =  # Konvey | 

try:
    api_response = api_instance.update_konvey(konveyId, konvey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KonveyApi->updateKonvey: %s\n" % e)
extern crate KonveyApi;

pub fn main() {
    let konveyId = konveyId_example; // String
    let konvey = ; // Konvey

    let mut context = KonveyApi::Context::default();
    let result = client.updateKonvey(konveyId, konvey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
konveyId*
String
The ID of the Konvey (Kowabunga Network Load-Balancer).
Required
Body parameters
Name Description
konvey *

Konvey payload.

Responses


Kylo

createProjectRegionKylo

Creates a new Kylo.


/project/{projectId}/region/{regionId}/kylo

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kylo?nfsId=nfsId_example" \
 -d '{
  "endpoint" : "endpoint",
  "access" : "RW",
  "size" : 6,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "protocols" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KyloApi;

import java.io.File;
import java.util.*;

public class KyloApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KyloApi apiInstance = new KyloApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kylo kylo = ; // Kylo | 
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#createProjectRegionKylo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Kylo kylo = new Kylo(); // Kylo | 
final String nfsId = new String(); // String | NFS storage ID (optional, region's default if unspecified).

try {
    final result = await api_instance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKylo: $e\n');
}

import org.openapitools.client.api.KyloApi;

public class KyloApiExample {
    public static void main(String[] args) {
        KyloApi apiInstance = new KyloApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kylo kylo = ; // Kylo | 
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#createProjectRegionKylo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KyloApi *apiInstance = [[KyloApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Kylo *kylo = ; // 
String *nfsId = nfsId_example; // NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance createProjectRegionKyloWith:projectId
    regionId:regionId
    kylo:kylo
    nfsId:nfsId
              completionHandler: ^(Kylo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KyloApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var kylo = ; // {Kylo} 
var opts = {
  'nfsId': nfsId_example // {String} NFS storage ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKylo(projectId, regionId, kylo, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKyloExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KyloApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var kylo = new Kylo(); // Kylo | 
            var nfsId = nfsId_example;  // String | NFS storage ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KyloApi.createProjectRegionKylo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KyloApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$kylo = ; // Kylo | 
$nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

try {
    $result = $api_instance->createProjectRegionKylo($projectId, $regionId, $kylo, $nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KyloApi->createProjectRegionKylo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KyloApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KyloApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $kylo = WWW::OPenAPIClient::Object::Kylo->new(); # Kylo | 
my $nfsId = nfsId_example; # String | NFS storage ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->createProjectRegionKylo(projectId => $projectId, regionId => $regionId, kylo => $kylo, nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KyloApi->createProjectRegionKylo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KyloApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
kylo =  # Kylo | 
nfsId = nfsId_example # String | NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.create_project_region_kylo(projectId, regionId, kylo, nfsId=nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KyloApi->createProjectRegionKylo: %s\n" % e)
extern crate KyloApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let kylo = ; // Kylo
    let nfsId = nfsId_example; // String

    let mut context = KyloApi::Context::default();
    let result = client.createProjectRegionKylo(projectId, regionId, kylo, nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
kylo *

Kylo payload.

Query parameters
Name Description
nfsId
String
NFS storage ID (optional, region's default if unspecified).

Responses


deleteKylo

Deletes an existing Kylo.


/kylo/{kyloId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kylo/{kyloId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KyloApi;

import java.io.File;
import java.util.*;

public class KyloApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KyloApi apiInstance = new KyloApi();
        String kyloId = kyloId_example; // String | The ID of the Kylo.

        try {
            apiInstance.deleteKylo(kyloId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#deleteKylo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kyloId = new String(); // String | The ID of the Kylo.

try {
    final result = await api_instance.deleteKylo(kyloId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteKylo: $e\n');
}

import org.openapitools.client.api.KyloApi;

public class KyloApiExample {
    public static void main(String[] args) {
        KyloApi apiInstance = new KyloApi();
        String kyloId = kyloId_example; // String | The ID of the Kylo.

        try {
            apiInstance.deleteKylo(kyloId);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#deleteKylo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KyloApi *apiInstance = [[KyloApi alloc] init];
String *kyloId = kyloId_example; // The ID of the Kylo. (default to null)

[apiInstance deleteKyloWith:kyloId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KyloApi()
var kyloId = kyloId_example; // {String} The ID of the Kylo.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteKylo(kyloId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteKyloExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KyloApi();
            var kyloId = kyloId_example;  // String | The ID of the Kylo. (default to null)

            try {
                apiInstance.deleteKylo(kyloId);
            } catch (Exception e) {
                Debug.Print("Exception when calling KyloApi.deleteKylo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KyloApi();
$kyloId = kyloId_example; // String | The ID of the Kylo.

try {
    $api_instance->deleteKylo($kyloId);
} catch (Exception $e) {
    echo 'Exception when calling KyloApi->deleteKylo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KyloApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KyloApi->new();
my $kyloId = kyloId_example; # String | The ID of the Kylo.

eval {
    $api_instance->deleteKylo(kyloId => $kyloId);
};
if ($@) {
    warn "Exception when calling KyloApi->deleteKylo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KyloApi()
kyloId = kyloId_example # String | The ID of the Kylo. (default to null)

try:
    api_instance.delete_kylo(kyloId)
except ApiException as e:
    print("Exception when calling KyloApi->deleteKylo: %s\n" % e)
extern crate KyloApi;

pub fn main() {
    let kyloId = kyloId_example; // String

    let mut context = KyloApi::Context::default();
    let result = client.deleteKylo(kyloId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kyloId*
String
The ID of the Kylo.
Required

Responses


listKylos

Returns the IDs of Kylo objects.


/kylo

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kylo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KyloApi;

import java.io.File;
import java.util.*;

public class KyloApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KyloApi apiInstance = new KyloApi();

        try {
            array['String'] result = apiInstance.listKylos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#listKylos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listKylos();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listKylos: $e\n');
}

import org.openapitools.client.api.KyloApi;

public class KyloApiExample {
    public static void main(String[] args) {
        KyloApi apiInstance = new KyloApi();

        try {
            array['String'] result = apiInstance.listKylos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#listKylos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KyloApi *apiInstance = [[KyloApi alloc] init];

[apiInstance listKylosWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KyloApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listKylos(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listKylosExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KyloApi();

            try {
                array['String'] result = apiInstance.listKylos();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KyloApi.listKylos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KyloApi();

try {
    $result = $api_instance->listKylos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KyloApi->listKylos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KyloApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KyloApi->new();

eval {
    my $result = $api_instance->listKylos();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KyloApi->listKylos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KyloApi()

try:
    api_response = api_instance.list_kylos()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KyloApi->listKylos: %s\n" % e)
extern crate KyloApi;

pub fn main() {

    let mut context = KyloApi::Context::default();
    let result = client.listKylos(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listProjectRegionKylos

Returns the IDs of Kylo objects.


/project/{projectId}/region/{regionId}/kylo

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kylo?nfsId=nfsId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KyloApi;

import java.io.File;
import java.util.*;

public class KyloApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KyloApi apiInstance = new KyloApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#listProjectRegionKylos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final String nfsId = new String(); // String | NFS storage ID (optional, region's default if unspecified).

try {
    final result = await api_instance.listProjectRegionKylos(projectId, regionId, nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKylos: $e\n');
}

import org.openapitools.client.api.KyloApi;

public class KyloApiExample {
    public static void main(String[] args) {
        KyloApi apiInstance = new KyloApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#listProjectRegionKylos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KyloApi *apiInstance = [[KyloApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
String *nfsId = nfsId_example; // NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance listProjectRegionKylosWith:projectId
    regionId:regionId
    nfsId:nfsId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KyloApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var opts = {
  'nfsId': nfsId_example // {String} NFS storage ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKylos(projectId, regionId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKylosExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KyloApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var nfsId = nfsId_example;  // String | NFS storage ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KyloApi.listProjectRegionKylos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KyloApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

try {
    $result = $api_instance->listProjectRegionKylos($projectId, $regionId, $nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KyloApi->listProjectRegionKylos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KyloApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KyloApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $nfsId = nfsId_example; # String | NFS storage ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->listProjectRegionKylos(projectId => $projectId, regionId => $regionId, nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KyloApi->listProjectRegionKylos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KyloApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
nfsId = nfsId_example # String | NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.list_project_region_kylos(projectId, regionId, nfsId=nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KyloApi->listProjectRegionKylos: %s\n" % e)
extern crate KyloApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let nfsId = nfsId_example; // String

    let mut context = KyloApi::Context::default();
    let result = client.listProjectRegionKylos(projectId, regionId, nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Query parameters
Name Description
nfsId
String
NFS storage ID (optional, region's default if unspecified).

Responses


listStorageNFSKylos

Returns the IDs of Kylo objects.


/nfs/{nfsId}/kylo

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/nfs/{nfsId}/kylo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KyloApi;

import java.io.File;
import java.util.*;

public class KyloApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KyloApi apiInstance = new KyloApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            array['String'] result = apiInstance.listStorageNFSKylos(nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#listStorageNFSKylos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String nfsId = new String(); // String | The ID of the NFS storage.

try {
    final result = await api_instance.listStorageNFSKylos(nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStorageNFSKylos: $e\n');
}

import org.openapitools.client.api.KyloApi;

public class KyloApiExample {
    public static void main(String[] args) {
        KyloApi apiInstance = new KyloApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            array['String'] result = apiInstance.listStorageNFSKylos(nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#listStorageNFSKylos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KyloApi *apiInstance = [[KyloApi alloc] init];
String *nfsId = nfsId_example; // The ID of the NFS storage. (default to null)

[apiInstance listStorageNFSKylosWith:nfsId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KyloApi()
var nfsId = nfsId_example; // {String} The ID of the NFS storage.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStorageNFSKylos(nfsId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listStorageNFSKylosExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KyloApi();
            var nfsId = nfsId_example;  // String | The ID of the NFS storage. (default to null)

            try {
                array['String'] result = apiInstance.listStorageNFSKylos(nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KyloApi.listStorageNFSKylos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KyloApi();
$nfsId = nfsId_example; // String | The ID of the NFS storage.

try {
    $result = $api_instance->listStorageNFSKylos($nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KyloApi->listStorageNFSKylos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KyloApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KyloApi->new();
my $nfsId = nfsId_example; # String | The ID of the NFS storage.

eval {
    my $result = $api_instance->listStorageNFSKylos(nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KyloApi->listStorageNFSKylos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KyloApi()
nfsId = nfsId_example # String | The ID of the NFS storage. (default to null)

try:
    api_response = api_instance.list_storage_nfs_kylos(nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KyloApi->listStorageNFSKylos: %s\n" % e)
extern crate KyloApi;

pub fn main() {
    let nfsId = nfsId_example; // String

    let mut context = KyloApi::Context::default();
    let result = client.listStorageNFSKylos(nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nfsId*
String
The ID of the NFS storage.
Required

Responses


readKylo

Returns a Kylo.


/kylo/{kyloId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/kylo/{kyloId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KyloApi;

import java.io.File;
import java.util.*;

public class KyloApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KyloApi apiInstance = new KyloApi();
        String kyloId = kyloId_example; // String | The ID of the Kylo.

        try {
            Kylo result = apiInstance.readKylo(kyloId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#readKylo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kyloId = new String(); // String | The ID of the Kylo.

try {
    final result = await api_instance.readKylo(kyloId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readKylo: $e\n');
}

import org.openapitools.client.api.KyloApi;

public class KyloApiExample {
    public static void main(String[] args) {
        KyloApi apiInstance = new KyloApi();
        String kyloId = kyloId_example; // String | The ID of the Kylo.

        try {
            Kylo result = apiInstance.readKylo(kyloId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#readKylo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KyloApi *apiInstance = [[KyloApi alloc] init];
String *kyloId = kyloId_example; // The ID of the Kylo. (default to null)

[apiInstance readKyloWith:kyloId
              completionHandler: ^(Kylo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KyloApi()
var kyloId = kyloId_example; // {String} The ID of the Kylo.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readKylo(kyloId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readKyloExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KyloApi();
            var kyloId = kyloId_example;  // String | The ID of the Kylo. (default to null)

            try {
                Kylo result = apiInstance.readKylo(kyloId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KyloApi.readKylo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KyloApi();
$kyloId = kyloId_example; // String | The ID of the Kylo.

try {
    $result = $api_instance->readKylo($kyloId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KyloApi->readKylo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KyloApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KyloApi->new();
my $kyloId = kyloId_example; # String | The ID of the Kylo.

eval {
    my $result = $api_instance->readKylo(kyloId => $kyloId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KyloApi->readKylo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KyloApi()
kyloId = kyloId_example # String | The ID of the Kylo. (default to null)

try:
    api_response = api_instance.read_kylo(kyloId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KyloApi->readKylo: %s\n" % e)
extern crate KyloApi;

pub fn main() {
    let kyloId = kyloId_example; // String

    let mut context = KyloApi::Context::default();
    let result = client.readKylo(kyloId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kyloId*
String
The ID of the Kylo.
Required

Responses


updateKylo

Updates a Kylo configuration.


/kylo/{kyloId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/kylo/{kyloId}" \
 -d '{
  "endpoint" : "endpoint",
  "access" : "RW",
  "size" : 6,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "protocols" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.KyloApi;

import java.io.File;
import java.util.*;

public class KyloApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        KyloApi apiInstance = new KyloApi();
        String kyloId = kyloId_example; // String | The ID of the Kylo.
        Kylo kylo = ; // Kylo | 

        try {
            Kylo result = apiInstance.updateKylo(kyloId, kylo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#updateKylo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String kyloId = new String(); // String | The ID of the Kylo.
final Kylo kylo = new Kylo(); // Kylo | 

try {
    final result = await api_instance.updateKylo(kyloId, kylo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateKylo: $e\n');
}

import org.openapitools.client.api.KyloApi;

public class KyloApiExample {
    public static void main(String[] args) {
        KyloApi apiInstance = new KyloApi();
        String kyloId = kyloId_example; // String | The ID of the Kylo.
        Kylo kylo = ; // Kylo | 

        try {
            Kylo result = apiInstance.updateKylo(kyloId, kylo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KyloApi#updateKylo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
KyloApi *apiInstance = [[KyloApi alloc] init];
String *kyloId = kyloId_example; // The ID of the Kylo. (default to null)
Kylo *kylo = ; // 

[apiInstance updateKyloWith:kyloId
    kylo:kylo
              completionHandler: ^(Kylo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.KyloApi()
var kyloId = kyloId_example; // {String} The ID of the Kylo.
var kylo = ; // {Kylo} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateKylo(kyloId, kylo, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateKyloExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new KyloApi();
            var kyloId = kyloId_example;  // String | The ID of the Kylo. (default to null)
            var kylo = new Kylo(); // Kylo | 

            try {
                Kylo result = apiInstance.updateKylo(kyloId, kylo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling KyloApi.updateKylo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\KyloApi();
$kyloId = kyloId_example; // String | The ID of the Kylo.
$kylo = ; // Kylo | 

try {
    $result = $api_instance->updateKylo($kyloId, $kylo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KyloApi->updateKylo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::KyloApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::KyloApi->new();
my $kyloId = kyloId_example; # String | The ID of the Kylo.
my $kylo = WWW::OPenAPIClient::Object::Kylo->new(); # Kylo | 

eval {
    my $result = $api_instance->updateKylo(kyloId => $kyloId, kylo => $kylo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KyloApi->updateKylo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.KyloApi()
kyloId = kyloId_example # String | The ID of the Kylo. (default to null)
kylo =  # Kylo | 

try:
    api_response = api_instance.update_kylo(kyloId, kylo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KyloApi->updateKylo: %s\n" % e)
extern crate KyloApi;

pub fn main() {
    let kyloId = kyloId_example; // String
    let kylo = ; // Kylo

    let mut context = KyloApi::Context::default();
    let result = client.updateKylo(kyloId, kylo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
kyloId*
String
The ID of the Kylo.
Required
Body parameters
Name Description
kylo *

Kylo payload.

Responses


Nfs

createStorageNFS

Creates a new NFS storage.


/region/{regionId}/nfs

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/nfs?poolId=poolId_example" \
 -d '{
  "endpoint" : "endpoint",
  "port" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "fs" : "nfs",
  "backends" : [ "backends", "backends" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NfsApi;

import java.io.File;
import java.util.*;

public class NfsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NfsApi apiInstance = new NfsApi();
        String regionId = regionId_example; // String | The ID of the region.
        StorageNFS storageNFS = ; // StorageNFS | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

        try {
            StorageNFS result = apiInstance.createStorageNFS(regionId, storageNFS, poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#createStorageNFS");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final StorageNFS storageNFS = new StorageNFS(); // StorageNFS | 
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).

try {
    final result = await api_instance.createStorageNFS(regionId, storageNFS, poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createStorageNFS: $e\n');
}

import org.openapitools.client.api.NfsApi;

public class NfsApiExample {
    public static void main(String[] args) {
        NfsApi apiInstance = new NfsApi();
        String regionId = regionId_example; // String | The ID of the region.
        StorageNFS storageNFS = ; // StorageNFS | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

        try {
            StorageNFS result = apiInstance.createStorageNFS(regionId, storageNFS, poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#createStorageNFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NfsApi *apiInstance = [[NfsApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
StorageNFS *storageNFS = ; // 
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance createStorageNFSWith:regionId
    storageNFS:storageNFS
    poolId:poolId
              completionHandler: ^(StorageNFS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.NfsApi()
var regionId = regionId_example; // {String} The ID of the region.
var storageNFS = ; // {StorageNFS} 
var opts = {
  'poolId': poolId_example // {String} Storage pool ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createStorageNFS(regionId, storageNFS, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createStorageNFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NfsApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var storageNFS = new StorageNFS(); // StorageNFS | 
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                StorageNFS result = apiInstance.createStorageNFS(regionId, storageNFS, poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NfsApi.createStorageNFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NfsApi();
$regionId = regionId_example; // String | The ID of the region.
$storageNFS = ; // StorageNFS | 
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

try {
    $result = $api_instance->createStorageNFS($regionId, $storageNFS, $poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NfsApi->createStorageNFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NfsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NfsApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $storageNFS = WWW::OPenAPIClient::Object::StorageNFS->new(); # StorageNFS | 
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->createStorageNFS(regionId => $regionId, storageNFS => $storageNFS, poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NfsApi->createStorageNFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NfsApi()
regionId = regionId_example # String | The ID of the region. (default to null)
storageNFS =  # StorageNFS | 
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.create_storage_nfs(regionId, storageNFS, poolId=poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NfsApi->createStorageNFS: %s\n" % e)
extern crate NfsApi;

pub fn main() {
    let regionId = regionId_example; // String
    let storageNFS = ; // StorageNFS
    let poolId = poolId_example; // String

    let mut context = NfsApi::Context::default();
    let result = client.createStorageNFS(regionId, storageNFS, poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
storageNFS *

StorageNFS payload.

Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).

Responses


deleteStorageNFS

Deletes an existing NFS storage.


/nfs/{nfsId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/nfs/{nfsId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NfsApi;

import java.io.File;
import java.util.*;

public class NfsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NfsApi apiInstance = new NfsApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            apiInstance.deleteStorageNFS(nfsId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#deleteStorageNFS");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String nfsId = new String(); // String | The ID of the NFS storage.

try {
    final result = await api_instance.deleteStorageNFS(nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteStorageNFS: $e\n');
}

import org.openapitools.client.api.NfsApi;

public class NfsApiExample {
    public static void main(String[] args) {
        NfsApi apiInstance = new NfsApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            apiInstance.deleteStorageNFS(nfsId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#deleteStorageNFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NfsApi *apiInstance = [[NfsApi alloc] init];
String *nfsId = nfsId_example; // The ID of the NFS storage. (default to null)

[apiInstance deleteStorageNFSWith:nfsId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.NfsApi()
var nfsId = nfsId_example; // {String} The ID of the NFS storage.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteStorageNFS(nfsId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteStorageNFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NfsApi();
            var nfsId = nfsId_example;  // String | The ID of the NFS storage. (default to null)

            try {
                apiInstance.deleteStorageNFS(nfsId);
            } catch (Exception e) {
                Debug.Print("Exception when calling NfsApi.deleteStorageNFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NfsApi();
$nfsId = nfsId_example; // String | The ID of the NFS storage.

try {
    $api_instance->deleteStorageNFS($nfsId);
} catch (Exception $e) {
    echo 'Exception when calling NfsApi->deleteStorageNFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NfsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NfsApi->new();
my $nfsId = nfsId_example; # String | The ID of the NFS storage.

eval {
    $api_instance->deleteStorageNFS(nfsId => $nfsId);
};
if ($@) {
    warn "Exception when calling NfsApi->deleteStorageNFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NfsApi()
nfsId = nfsId_example # String | The ID of the NFS storage. (default to null)

try:
    api_instance.delete_storage_nfs(nfsId)
except ApiException as e:
    print("Exception when calling NfsApi->deleteStorageNFS: %s\n" % e)
extern crate NfsApi;

pub fn main() {
    let nfsId = nfsId_example; // String

    let mut context = NfsApi::Context::default();
    let result = client.deleteStorageNFS(nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nfsId*
String
The ID of the NFS storage.
Required

Responses


listRegionStorageNFSs

Returns the IDs of NFS storage objects.


/region/{regionId}/nfs

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/nfs?poolId=poolId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NfsApi;

import java.io.File;
import java.util.*;

public class NfsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NfsApi apiInstance = new NfsApi();
        String regionId = regionId_example; // String | The ID of the region.
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listRegionStorageNFSs(regionId, poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#listRegionStorageNFSs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).

try {
    final result = await api_instance.listRegionStorageNFSs(regionId, poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionStorageNFSs: $e\n');
}

import org.openapitools.client.api.NfsApi;

public class NfsApiExample {
    public static void main(String[] args) {
        NfsApi apiInstance = new NfsApi();
        String regionId = regionId_example; // String | The ID of the region.
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listRegionStorageNFSs(regionId, poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#listRegionStorageNFSs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NfsApi *apiInstance = [[NfsApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance listRegionStorageNFSsWith:regionId
    poolId:poolId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.NfsApi()
var regionId = regionId_example; // {String} The ID of the region.
var opts = {
  'poolId': poolId_example // {String} Storage pool ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionStorageNFSs(regionId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionStorageNFSsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NfsApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                array['String'] result = apiInstance.listRegionStorageNFSs(regionId, poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NfsApi.listRegionStorageNFSs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NfsApi();
$regionId = regionId_example; // String | The ID of the region.
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

try {
    $result = $api_instance->listRegionStorageNFSs($regionId, $poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NfsApi->listRegionStorageNFSs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NfsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NfsApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->listRegionStorageNFSs(regionId => $regionId, poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NfsApi->listRegionStorageNFSs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NfsApi()
regionId = regionId_example # String | The ID of the region. (default to null)
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.list_region_storage_nfss(regionId, poolId=poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NfsApi->listRegionStorageNFSs: %s\n" % e)
extern crate NfsApi;

pub fn main() {
    let regionId = regionId_example; // String
    let poolId = poolId_example; // String

    let mut context = NfsApi::Context::default();
    let result = client.listRegionStorageNFSs(regionId, poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).

Responses


listStorageNFSKylos

Returns the IDs of Kylo objects.


/nfs/{nfsId}/kylo

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/nfs/{nfsId}/kylo"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NfsApi;

import java.io.File;
import java.util.*;

public class NfsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NfsApi apiInstance = new NfsApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            array['String'] result = apiInstance.listStorageNFSKylos(nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#listStorageNFSKylos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String nfsId = new String(); // String | The ID of the NFS storage.

try {
    final result = await api_instance.listStorageNFSKylos(nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStorageNFSKylos: $e\n');
}

import org.openapitools.client.api.NfsApi;

public class NfsApiExample {
    public static void main(String[] args) {
        NfsApi apiInstance = new NfsApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            array['String'] result = apiInstance.listStorageNFSKylos(nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#listStorageNFSKylos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NfsApi *apiInstance = [[NfsApi alloc] init];
String *nfsId = nfsId_example; // The ID of the NFS storage. (default to null)

[apiInstance listStorageNFSKylosWith:nfsId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.NfsApi()
var nfsId = nfsId_example; // {String} The ID of the NFS storage.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStorageNFSKylos(nfsId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listStorageNFSKylosExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NfsApi();
            var nfsId = nfsId_example;  // String | The ID of the NFS storage. (default to null)

            try {
                array['String'] result = apiInstance.listStorageNFSKylos(nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NfsApi.listStorageNFSKylos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NfsApi();
$nfsId = nfsId_example; // String | The ID of the NFS storage.

try {
    $result = $api_instance->listStorageNFSKylos($nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NfsApi->listStorageNFSKylos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NfsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NfsApi->new();
my $nfsId = nfsId_example; # String | The ID of the NFS storage.

eval {
    my $result = $api_instance->listStorageNFSKylos(nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NfsApi->listStorageNFSKylos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NfsApi()
nfsId = nfsId_example # String | The ID of the NFS storage. (default to null)

try:
    api_response = api_instance.list_storage_nfs_kylos(nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NfsApi->listStorageNFSKylos: %s\n" % e)
extern crate NfsApi;

pub fn main() {
    let nfsId = nfsId_example; // String

    let mut context = NfsApi::Context::default();
    let result = client.listStorageNFSKylos(nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nfsId*
String
The ID of the NFS storage.
Required

Responses


listStorageNFSs

Returns the IDs of NFS storage objects.


/nfs

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/nfs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NfsApi;

import java.io.File;
import java.util.*;

public class NfsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NfsApi apiInstance = new NfsApi();

        try {
            array['String'] result = apiInstance.listStorageNFSs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#listStorageNFSs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listStorageNFSs();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStorageNFSs: $e\n');
}

import org.openapitools.client.api.NfsApi;

public class NfsApiExample {
    public static void main(String[] args) {
        NfsApi apiInstance = new NfsApi();

        try {
            array['String'] result = apiInstance.listStorageNFSs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#listStorageNFSs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NfsApi *apiInstance = [[NfsApi alloc] init];

[apiInstance listStorageNFSsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.NfsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStorageNFSs(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listStorageNFSsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NfsApi();

            try {
                array['String'] result = apiInstance.listStorageNFSs();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NfsApi.listStorageNFSs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NfsApi();

try {
    $result = $api_instance->listStorageNFSs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NfsApi->listStorageNFSs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NfsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NfsApi->new();

eval {
    my $result = $api_instance->listStorageNFSs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NfsApi->listStorageNFSs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NfsApi()

try:
    api_response = api_instance.list_storage_nfss()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NfsApi->listStorageNFSs: %s\n" % e)
extern crate NfsApi;

pub fn main() {

    let mut context = NfsApi::Context::default();
    let result = client.listStorageNFSs(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readStorageNFS

Returns a NFS storage.


/nfs/{nfsId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/nfs/{nfsId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NfsApi;

import java.io.File;
import java.util.*;

public class NfsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NfsApi apiInstance = new NfsApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            StorageNFS result = apiInstance.readStorageNFS(nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#readStorageNFS");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String nfsId = new String(); // String | The ID of the NFS storage.

try {
    final result = await api_instance.readStorageNFS(nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readStorageNFS: $e\n');
}

import org.openapitools.client.api.NfsApi;

public class NfsApiExample {
    public static void main(String[] args) {
        NfsApi apiInstance = new NfsApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            StorageNFS result = apiInstance.readStorageNFS(nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#readStorageNFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NfsApi *apiInstance = [[NfsApi alloc] init];
String *nfsId = nfsId_example; // The ID of the NFS storage. (default to null)

[apiInstance readStorageNFSWith:nfsId
              completionHandler: ^(StorageNFS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.NfsApi()
var nfsId = nfsId_example; // {String} The ID of the NFS storage.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readStorageNFS(nfsId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readStorageNFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NfsApi();
            var nfsId = nfsId_example;  // String | The ID of the NFS storage. (default to null)

            try {
                StorageNFS result = apiInstance.readStorageNFS(nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NfsApi.readStorageNFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NfsApi();
$nfsId = nfsId_example; // String | The ID of the NFS storage.

try {
    $result = $api_instance->readStorageNFS($nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NfsApi->readStorageNFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NfsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NfsApi->new();
my $nfsId = nfsId_example; # String | The ID of the NFS storage.

eval {
    my $result = $api_instance->readStorageNFS(nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NfsApi->readStorageNFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NfsApi()
nfsId = nfsId_example # String | The ID of the NFS storage. (default to null)

try:
    api_response = api_instance.read_storage_nfs(nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NfsApi->readStorageNFS: %s\n" % e)
extern crate NfsApi;

pub fn main() {
    let nfsId = nfsId_example; // String

    let mut context = NfsApi::Context::default();
    let result = client.readStorageNFS(nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nfsId*
String
The ID of the NFS storage.
Required

Responses


setRegionDefaultStorageNFS

Performs a region setting of default NFS storage.


/region/{regionId}/nfs/{nfsId}/default

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/nfs/{nfsId}/default"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NfsApi;

import java.io.File;
import java.util.*;

public class NfsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NfsApi apiInstance = new NfsApi();
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            apiInstance.setRegionDefaultStorageNFS(regionId, nfsId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#setRegionDefaultStorageNFS");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final String nfsId = new String(); // String | The ID of the NFS storage.

try {
    final result = await api_instance.setRegionDefaultStorageNFS(regionId, nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setRegionDefaultStorageNFS: $e\n');
}

import org.openapitools.client.api.NfsApi;

public class NfsApiExample {
    public static void main(String[] args) {
        NfsApi apiInstance = new NfsApi();
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            apiInstance.setRegionDefaultStorageNFS(regionId, nfsId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#setRegionDefaultStorageNFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NfsApi *apiInstance = [[NfsApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
String *nfsId = nfsId_example; // The ID of the NFS storage. (default to null)

[apiInstance setRegionDefaultStorageNFSWith:regionId
    nfsId:nfsId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.NfsApi()
var regionId = regionId_example; // {String} The ID of the region.
var nfsId = nfsId_example; // {String} The ID of the NFS storage.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setRegionDefaultStorageNFS(regionId, nfsId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setRegionDefaultStorageNFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NfsApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var nfsId = nfsId_example;  // String | The ID of the NFS storage. (default to null)

            try {
                apiInstance.setRegionDefaultStorageNFS(regionId, nfsId);
            } catch (Exception e) {
                Debug.Print("Exception when calling NfsApi.setRegionDefaultStorageNFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NfsApi();
$regionId = regionId_example; // String | The ID of the region.
$nfsId = nfsId_example; // String | The ID of the NFS storage.

try {
    $api_instance->setRegionDefaultStorageNFS($regionId, $nfsId);
} catch (Exception $e) {
    echo 'Exception when calling NfsApi->setRegionDefaultStorageNFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NfsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NfsApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $nfsId = nfsId_example; # String | The ID of the NFS storage.

eval {
    $api_instance->setRegionDefaultStorageNFS(regionId => $regionId, nfsId => $nfsId);
};
if ($@) {
    warn "Exception when calling NfsApi->setRegionDefaultStorageNFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NfsApi()
regionId = regionId_example # String | The ID of the region. (default to null)
nfsId = nfsId_example # String | The ID of the NFS storage. (default to null)

try:
    api_instance.set_region_default_storage_nfs(regionId, nfsId)
except ApiException as e:
    print("Exception when calling NfsApi->setRegionDefaultStorageNFS: %s\n" % e)
extern crate NfsApi;

pub fn main() {
    let regionId = regionId_example; // String
    let nfsId = nfsId_example; // String

    let mut context = NfsApi::Context::default();
    let result = client.setRegionDefaultStorageNFS(regionId, nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
nfsId*
String
The ID of the NFS storage.
Required

Responses


updateStorageNFS

Updates a NFS storage configuration.


/nfs/{nfsId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/nfs/{nfsId}" \
 -d '{
  "endpoint" : "endpoint",
  "port" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "fs" : "nfs",
  "backends" : [ "backends", "backends" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NfsApi;

import java.io.File;
import java.util.*;

public class NfsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        NfsApi apiInstance = new NfsApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.
        StorageNFS storageNFS = ; // StorageNFS | 

        try {
            StorageNFS result = apiInstance.updateStorageNFS(nfsId, storageNFS);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#updateStorageNFS");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String nfsId = new String(); // String | The ID of the NFS storage.
final StorageNFS storageNFS = new StorageNFS(); // StorageNFS | 

try {
    final result = await api_instance.updateStorageNFS(nfsId, storageNFS);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateStorageNFS: $e\n');
}

import org.openapitools.client.api.NfsApi;

public class NfsApiExample {
    public static void main(String[] args) {
        NfsApi apiInstance = new NfsApi();
        String nfsId = nfsId_example; // String | The ID of the NFS storage.
        StorageNFS storageNFS = ; // StorageNFS | 

        try {
            StorageNFS result = apiInstance.updateStorageNFS(nfsId, storageNFS);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NfsApi#updateStorageNFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
NfsApi *apiInstance = [[NfsApi alloc] init];
String *nfsId = nfsId_example; // The ID of the NFS storage. (default to null)
StorageNFS *storageNFS = ; // 

[apiInstance updateStorageNFSWith:nfsId
    storageNFS:storageNFS
              completionHandler: ^(StorageNFS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.NfsApi()
var nfsId = nfsId_example; // {String} The ID of the NFS storage.
var storageNFS = ; // {StorageNFS} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateStorageNFS(nfsId, storageNFS, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateStorageNFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new NfsApi();
            var nfsId = nfsId_example;  // String | The ID of the NFS storage. (default to null)
            var storageNFS = new StorageNFS(); // StorageNFS | 

            try {
                StorageNFS result = apiInstance.updateStorageNFS(nfsId, storageNFS);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NfsApi.updateStorageNFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NfsApi();
$nfsId = nfsId_example; // String | The ID of the NFS storage.
$storageNFS = ; // StorageNFS | 

try {
    $result = $api_instance->updateStorageNFS($nfsId, $storageNFS);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NfsApi->updateStorageNFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NfsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NfsApi->new();
my $nfsId = nfsId_example; # String | The ID of the NFS storage.
my $storageNFS = WWW::OPenAPIClient::Object::StorageNFS->new(); # StorageNFS | 

eval {
    my $result = $api_instance->updateStorageNFS(nfsId => $nfsId, storageNFS => $storageNFS);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NfsApi->updateStorageNFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.NfsApi()
nfsId = nfsId_example # String | The ID of the NFS storage. (default to null)
storageNFS =  # StorageNFS | 

try:
    api_response = api_instance.update_storage_nfs(nfsId, storageNFS)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NfsApi->updateStorageNFS: %s\n" % e)
extern crate NfsApi;

pub fn main() {
    let nfsId = nfsId_example; // String
    let storageNFS = ; // StorageNFS

    let mut context = NfsApi::Context::default();
    let result = client.updateStorageNFS(nfsId, storageNFS, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
nfsId*
String
The ID of the NFS storage.
Required
Body parameters
Name Description
storageNFS *

StorageNFS payload.

Responses


Pool

createStoragePool

Creates a new storage pool.


/region/{regionId}/pool

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/pool" \
 -d '{
  "ceph_secret_uuid" : "ceph_secret_uuid",
  "cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "name" : "name",
  "pool" : "pool",
  "ceph_port" : 0,
  "description" : "description",
  "id" : "id",
  "ceph_address" : "localhost",
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String regionId = regionId_example; // String | The ID of the region.
        StoragePool storagePool = ; // StoragePool | 

        try {
            StoragePool result = apiInstance.createStoragePool(regionId, storagePool);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#createStoragePool");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final StoragePool storagePool = new StoragePool(); // StoragePool | 

try {
    final result = await api_instance.createStoragePool(regionId, storagePool);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createStoragePool: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String regionId = regionId_example; // String | The ID of the region.
        StoragePool storagePool = ; // StoragePool | 

        try {
            StoragePool result = apiInstance.createStoragePool(regionId, storagePool);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#createStoragePool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
StoragePool *storagePool = ; // 

[apiInstance createStoragePoolWith:regionId
    storagePool:storagePool
              completionHandler: ^(StoragePool output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var regionId = regionId_example; // {String} The ID of the region.
var storagePool = ; // {StoragePool} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createStoragePool(regionId, storagePool, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createStoragePoolExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var storagePool = new StoragePool(); // StoragePool | 

            try {
                StoragePool result = apiInstance.createStoragePool(regionId, storagePool);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.createStoragePool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$regionId = regionId_example; // String | The ID of the region.
$storagePool = ; // StoragePool | 

try {
    $result = $api_instance->createStoragePool($regionId, $storagePool);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->createStoragePool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $storagePool = WWW::OPenAPIClient::Object::StoragePool->new(); # StoragePool | 

eval {
    my $result = $api_instance->createStoragePool(regionId => $regionId, storagePool => $storagePool);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolApi->createStoragePool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
regionId = regionId_example # String | The ID of the region. (default to null)
storagePool =  # StoragePool | 

try:
    api_response = api_instance.create_storage_pool(regionId, storagePool)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolApi->createStoragePool: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let regionId = regionId_example; // String
    let storagePool = ; // StoragePool

    let mut context = PoolApi::Context::default();
    let result = client.createStoragePool(regionId, storagePool, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
storagePool *

StoragePool payload.

Responses


createTemplate

Creates a new image template.


/pool/{poolId}/template

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/pool/{poolId}/template" \
 -d '{
  "os" : "linux",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "source" : "source"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        Template template = ; // Template | 

        try {
            Template result = apiInstance.createTemplate(poolId, template);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#createTemplate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.
final Template template = new Template(); // Template | 

try {
    final result = await api_instance.createTemplate(poolId, template);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTemplate: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        Template template = ; // Template | 

        try {
            Template result = apiInstance.createTemplate(poolId, template);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#createTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)
Template *template = ; // 

[apiInstance createTemplateWith:poolId
    template:template
              completionHandler: ^(Template output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var poolId = poolId_example; // {String} The ID of the storage pool.
var template = ; // {Template} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTemplate(poolId, template, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)
            var template = new Template(); // Template | 

            try {
                Template result = apiInstance.createTemplate(poolId, template);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.createTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$poolId = poolId_example; // String | The ID of the storage pool.
$template = ; // Template | 

try {
    $result = $api_instance->createTemplate($poolId, $template);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->createTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.
my $template = WWW::OPenAPIClient::Object::Template->new(); # Template | 

eval {
    my $result = $api_instance->createTemplate(poolId => $poolId, template => $template);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolApi->createTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)
template =  # Template | 

try:
    api_response = api_instance.create_template(poolId, template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolApi->createTemplate: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let poolId = poolId_example; // String
    let template = ; // Template

    let mut context = PoolApi::Context::default();
    let result = client.createTemplate(poolId, template, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required
Body parameters
Name Description
template *

Template payload.

Responses


deleteStoragePool

Deletes an existing storage pool.


/pool/{poolId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool/{poolId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            apiInstance.deleteStoragePool(poolId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#deleteStoragePool");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.

try {
    final result = await api_instance.deleteStoragePool(poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteStoragePool: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            apiInstance.deleteStoragePool(poolId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#deleteStoragePool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)

[apiInstance deleteStoragePoolWith:poolId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var poolId = poolId_example; // {String} The ID of the storage pool.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteStoragePool(poolId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteStoragePoolExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)

            try {
                apiInstance.deleteStoragePool(poolId);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.deleteStoragePool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$poolId = poolId_example; // String | The ID of the storage pool.

try {
    $api_instance->deleteStoragePool($poolId);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->deleteStoragePool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.

eval {
    $api_instance->deleteStoragePool(poolId => $poolId);
};
if ($@) {
    warn "Exception when calling PoolApi->deleteStoragePool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)

try:
    api_instance.delete_storage_pool(poolId)
except ApiException as e:
    print("Exception when calling PoolApi->deleteStoragePool: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let poolId = poolId_example; // String

    let mut context = PoolApi::Context::default();
    let result = client.deleteStoragePool(poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required

Responses


listRegionStoragePools

Returns the IDs of storage pool objects.


/region/{regionId}/pools

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/pools"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionStoragePools(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#listRegionStoragePools");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listRegionStoragePools(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionStoragePools: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionStoragePools(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#listRegionStoragePools");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listRegionStoragePoolsWith:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionStoragePools(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionStoragePoolsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listRegionStoragePools(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.listRegionStoragePools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listRegionStoragePools($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->listRegionStoragePools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listRegionStoragePools(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolApi->listRegionStoragePools: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_region_storage_pools(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolApi->listRegionStoragePools: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = PoolApi::Context::default();
    let result = client.listRegionStoragePools(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


listStoragePoolTemplates

Returns the IDs of image template objects.


/pool/{poolId}/templates

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool/{poolId}/templates"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            array['String'] result = apiInstance.listStoragePoolTemplates(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#listStoragePoolTemplates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.

try {
    final result = await api_instance.listStoragePoolTemplates(poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStoragePoolTemplates: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            array['String'] result = apiInstance.listStoragePoolTemplates(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#listStoragePoolTemplates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)

[apiInstance listStoragePoolTemplatesWith:poolId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var poolId = poolId_example; // {String} The ID of the storage pool.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStoragePoolTemplates(poolId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listStoragePoolTemplatesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)

            try {
                array['String'] result = apiInstance.listStoragePoolTemplates(poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.listStoragePoolTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$poolId = poolId_example; // String | The ID of the storage pool.

try {
    $result = $api_instance->listStoragePoolTemplates($poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->listStoragePoolTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.

eval {
    my $result = $api_instance->listStoragePoolTemplates(poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolApi->listStoragePoolTemplates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)

try:
    api_response = api_instance.list_storage_pool_templates(poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolApi->listStoragePoolTemplates: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let poolId = poolId_example; // String

    let mut context = PoolApi::Context::default();
    let result = client.listStoragePoolTemplates(poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required

Responses


listStoragePoolVolumes

Returns the IDs of storage volume objects.


/pool/{poolId}/volumes

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool/{poolId}/volumes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            array['String'] result = apiInstance.listStoragePoolVolumes(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#listStoragePoolVolumes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.

try {
    final result = await api_instance.listStoragePoolVolumes(poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStoragePoolVolumes: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            array['String'] result = apiInstance.listStoragePoolVolumes(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#listStoragePoolVolumes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)

[apiInstance listStoragePoolVolumesWith:poolId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var poolId = poolId_example; // {String} The ID of the storage pool.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStoragePoolVolumes(poolId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listStoragePoolVolumesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)

            try {
                array['String'] result = apiInstance.listStoragePoolVolumes(poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.listStoragePoolVolumes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$poolId = poolId_example; // String | The ID of the storage pool.

try {
    $result = $api_instance->listStoragePoolVolumes($poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->listStoragePoolVolumes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.

eval {
    my $result = $api_instance->listStoragePoolVolumes(poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolApi->listStoragePoolVolumes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)

try:
    api_response = api_instance.list_storage_pool_volumes(poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolApi->listStoragePoolVolumes: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let poolId = poolId_example; // String

    let mut context = PoolApi::Context::default();
    let result = client.listStoragePoolVolumes(poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required

Responses


listStoragePools

Returns the IDs of storage pool objects.


/pool

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();

        try {
            array['String'] result = apiInstance.listStoragePools();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#listStoragePools");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listStoragePools();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStoragePools: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();

        try {
            array['String'] result = apiInstance.listStoragePools();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#listStoragePools");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];

[apiInstance listStoragePoolsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStoragePools(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listStoragePoolsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();

            try {
                array['String'] result = apiInstance.listStoragePools();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.listStoragePools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();

try {
    $result = $api_instance->listStoragePools();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->listStoragePools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();

eval {
    my $result = $api_instance->listStoragePools();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolApi->listStoragePools: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()

try:
    api_response = api_instance.list_storage_pools()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolApi->listStoragePools: %s\n" % e)
extern crate PoolApi;

pub fn main() {

    let mut context = PoolApi::Context::default();
    let result = client.listStoragePools(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readStoragePool

Returns a storage pool.


/pool/{poolId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool/{poolId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            StoragePool result = apiInstance.readStoragePool(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#readStoragePool");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.

try {
    final result = await api_instance.readStoragePool(poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readStoragePool: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            StoragePool result = apiInstance.readStoragePool(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#readStoragePool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)

[apiInstance readStoragePoolWith:poolId
              completionHandler: ^(StoragePool output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var poolId = poolId_example; // {String} The ID of the storage pool.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readStoragePool(poolId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readStoragePoolExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)

            try {
                StoragePool result = apiInstance.readStoragePool(poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.readStoragePool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$poolId = poolId_example; // String | The ID of the storage pool.

try {
    $result = $api_instance->readStoragePool($poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->readStoragePool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.

eval {
    my $result = $api_instance->readStoragePool(poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolApi->readStoragePool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)

try:
    api_response = api_instance.read_storage_pool(poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolApi->readStoragePool: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let poolId = poolId_example; // String

    let mut context = PoolApi::Context::default();
    let result = client.readStoragePool(poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required

Responses


setRegionDefaultStoragePool

Performs a region setting of default storage pool.


/region/{regionId}/pool/{poolId}/default

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/pool/{poolId}/default"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String regionId = regionId_example; // String | The ID of the region.
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            apiInstance.setRegionDefaultStoragePool(regionId, poolId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#setRegionDefaultStoragePool");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final String poolId = new String(); // String | The ID of the storage pool.

try {
    final result = await api_instance.setRegionDefaultStoragePool(regionId, poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setRegionDefaultStoragePool: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String regionId = regionId_example; // String | The ID of the region.
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            apiInstance.setRegionDefaultStoragePool(regionId, poolId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#setRegionDefaultStoragePool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
String *poolId = poolId_example; // The ID of the storage pool. (default to null)

[apiInstance setRegionDefaultStoragePoolWith:regionId
    poolId:poolId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var regionId = regionId_example; // {String} The ID of the region.
var poolId = poolId_example; // {String} The ID of the storage pool.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setRegionDefaultStoragePool(regionId, poolId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setRegionDefaultStoragePoolExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)

            try {
                apiInstance.setRegionDefaultStoragePool(regionId, poolId);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.setRegionDefaultStoragePool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$regionId = regionId_example; // String | The ID of the region.
$poolId = poolId_example; // String | The ID of the storage pool.

try {
    $api_instance->setRegionDefaultStoragePool($regionId, $poolId);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->setRegionDefaultStoragePool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $poolId = poolId_example; # String | The ID of the storage pool.

eval {
    $api_instance->setRegionDefaultStoragePool(regionId => $regionId, poolId => $poolId);
};
if ($@) {
    warn "Exception when calling PoolApi->setRegionDefaultStoragePool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
regionId = regionId_example # String | The ID of the region. (default to null)
poolId = poolId_example # String | The ID of the storage pool. (default to null)

try:
    api_instance.set_region_default_storage_pool(regionId, poolId)
except ApiException as e:
    print("Exception when calling PoolApi->setRegionDefaultStoragePool: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let regionId = regionId_example; // String
    let poolId = poolId_example; // String

    let mut context = PoolApi::Context::default();
    let result = client.setRegionDefaultStoragePool(regionId, poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
poolId*
String
The ID of the storage pool.
Required

Responses


setStoragePoolDefaultTemplate

Performs a storage pool setting of default template.


/pool/{poolId}/template/{templateId}/default

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool/{poolId}/template/{templateId}/default"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        String templateId = templateId_example; // String | The ID of the image template.

        try {
            apiInstance.setStoragePoolDefaultTemplate(poolId, templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#setStoragePoolDefaultTemplate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.
final String templateId = new String(); // String | The ID of the image template.

try {
    final result = await api_instance.setStoragePoolDefaultTemplate(poolId, templateId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setStoragePoolDefaultTemplate: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        String templateId = templateId_example; // String | The ID of the image template.

        try {
            apiInstance.setStoragePoolDefaultTemplate(poolId, templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#setStoragePoolDefaultTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)
String *templateId = templateId_example; // The ID of the image template. (default to null)

[apiInstance setStoragePoolDefaultTemplateWith:poolId
    templateId:templateId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var poolId = poolId_example; // {String} The ID of the storage pool.
var templateId = templateId_example; // {String} The ID of the image template.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setStoragePoolDefaultTemplate(poolId, templateId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setStoragePoolDefaultTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)
            var templateId = templateId_example;  // String | The ID of the image template. (default to null)

            try {
                apiInstance.setStoragePoolDefaultTemplate(poolId, templateId);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.setStoragePoolDefaultTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$poolId = poolId_example; // String | The ID of the storage pool.
$templateId = templateId_example; // String | The ID of the image template.

try {
    $api_instance->setStoragePoolDefaultTemplate($poolId, $templateId);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->setStoragePoolDefaultTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.
my $templateId = templateId_example; # String | The ID of the image template.

eval {
    $api_instance->setStoragePoolDefaultTemplate(poolId => $poolId, templateId => $templateId);
};
if ($@) {
    warn "Exception when calling PoolApi->setStoragePoolDefaultTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)
templateId = templateId_example # String | The ID of the image template. (default to null)

try:
    api_instance.set_storage_pool_default_template(poolId, templateId)
except ApiException as e:
    print("Exception when calling PoolApi->setStoragePoolDefaultTemplate: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let poolId = poolId_example; // String
    let templateId = templateId_example; // String

    let mut context = PoolApi::Context::default();
    let result = client.setStoragePoolDefaultTemplate(poolId, templateId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required
templateId*
String
The ID of the image template.
Required

Responses


updateStoragePool

Updates a storage pool configuration.


/pool/{poolId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/pool/{poolId}" \
 -d '{
  "ceph_secret_uuid" : "ceph_secret_uuid",
  "cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "name" : "name",
  "pool" : "pool",
  "ceph_port" : 0,
  "description" : "description",
  "id" : "id",
  "ceph_address" : "localhost",
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoolApi;

import java.io.File;
import java.util.*;

public class PoolApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        StoragePool storagePool = ; // StoragePool | 

        try {
            StoragePool result = apiInstance.updateStoragePool(poolId, storagePool);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#updateStoragePool");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.
final StoragePool storagePool = new StoragePool(); // StoragePool | 

try {
    final result = await api_instance.updateStoragePool(poolId, storagePool);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateStoragePool: $e\n');
}

import org.openapitools.client.api.PoolApi;

public class PoolApiExample {
    public static void main(String[] args) {
        PoolApi apiInstance = new PoolApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        StoragePool storagePool = ; // StoragePool | 

        try {
            StoragePool result = apiInstance.updateStoragePool(poolId, storagePool);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoolApi#updateStoragePool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
PoolApi *apiInstance = [[PoolApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)
StoragePool *storagePool = ; // 

[apiInstance updateStoragePoolWith:poolId
    storagePool:storagePool
              completionHandler: ^(StoragePool output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.PoolApi()
var poolId = poolId_example; // {String} The ID of the storage pool.
var storagePool = ; // {StoragePool} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateStoragePool(poolId, storagePool, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateStoragePoolExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new PoolApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)
            var storagePool = new StoragePool(); // StoragePool | 

            try {
                StoragePool result = apiInstance.updateStoragePool(poolId, storagePool);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoolApi.updateStoragePool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoolApi();
$poolId = poolId_example; // String | The ID of the storage pool.
$storagePool = ; // StoragePool | 

try {
    $result = $api_instance->updateStoragePool($poolId, $storagePool);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoolApi->updateStoragePool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoolApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoolApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.
my $storagePool = WWW::OPenAPIClient::Object::StoragePool->new(); # StoragePool | 

eval {
    my $result = $api_instance->updateStoragePool(poolId => $poolId, storagePool => $storagePool);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoolApi->updateStoragePool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.PoolApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)
storagePool =  # StoragePool | 

try:
    api_response = api_instance.update_storage_pool(poolId, storagePool)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolApi->updateStoragePool: %s\n" % e)
extern crate PoolApi;

pub fn main() {
    let poolId = poolId_example; // String
    let storagePool = ; // StoragePool

    let mut context = PoolApi::Context::default();
    let result = client.updateStoragePool(poolId, storagePool, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required
Body parameters
Name Description
storagePool *

StoragePool payload.

Responses


Project

createProject

Creates a new project.


/project

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project?subnetSize=56" \
 -d '{
  "quotas" : {
    "memory" : 6,
    "instances" : 5,
    "storage" : 1,
    "vcpus" : 0
  },
  "regions" : [ "regions", "regions" ],
  "teams" : [ "teams", "teams" ],
  "metadatas" : [ {
    "value" : "value",
    "key" : "key"
  }, {
    "value" : "value",
    "key" : "key"
  } ],
  "root_password" : "root_password",
  "description" : "description",
  "bootstrap_user" : "bootstrap_user",
  "tags" : [ "tags", "tags" ],
  "reserved_vrrp_ids" : [ 5, 5 ],
  "bootstrap_pubkey" : "bootstrap_pubkey",
  "private_subnets" : [ {
    "value" : "value",
    "key" : "key"
  }, {
    "value" : "value",
    "key" : "key"
  } ],
  "domain" : "domain",
  "name" : "name",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Project project = ; // Project | 
        Integer subnetSize = 56; // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

        try {
            Project result = apiInstance.createProject(project, subnetSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Project project = new Project(); // Project | 
final Integer subnetSize = new Integer(); // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

try {
    final result = await api_instance.createProject(project, subnetSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProject: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Project project = ; // Project | 
        Integer subnetSize = 56; // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

        try {
            Project result = apiInstance.createProject(project, subnetSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Project *project = ; // 
Integer *subnetSize = 56; // The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later. (optional) (default to null)

[apiInstance createProjectWith:project
    subnetSize:subnetSize
              completionHandler: ^(Project output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var project = ; // {Project} 
var opts = {
  'subnetSize': 56 // {Integer} The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProject(project, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var project = new Project(); // Project | 
            var subnetSize = 56;  // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later. (optional)  (default to null)

            try {
                Project result = apiInstance.createProject(project, subnetSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$project = ; // Project | 
$subnetSize = 56; // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

try {
    $result = $api_instance->createProject($project, $subnetSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $project = WWW::OPenAPIClient::Object::Project->new(); # Project | 
my $subnetSize = 56; # Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

eval {
    my $result = $api_instance->createProject(project => $project, subnetSize => $subnetSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
project =  # Project | 
subnetSize = 56 # Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later. (optional) (default to null)

try:
    api_response = api_instance.create_project(project, subnetSize=subnetSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let project = ; // Project
    let subnetSize = 56; // Integer

    let mut context = ProjectApi::Context::default();
    let result = client.createProject(project, subnetSize, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
project *

Project payload.

Query parameters
Name Description
subnetSize
Integer
The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

Responses


createProjectDnsRecord

Creates a new DNS record.


/project/{projectId}/record

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/record" \
 -d '{
  "addresses" : [ "addresses", "addresses" ],
  "domain" : "domain",
  "name" : "name",
  "description" : "description",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        DnsRecord dnsRecord = ; // DnsRecord | 

        try {
            DnsRecord result = apiInstance.createProjectDnsRecord(projectId, dnsRecord);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectDnsRecord");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final DnsRecord dnsRecord = new DnsRecord(); // DnsRecord | 

try {
    final result = await api_instance.createProjectDnsRecord(projectId, dnsRecord);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectDnsRecord: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        DnsRecord dnsRecord = ; // DnsRecord | 

        try {
            DnsRecord result = apiInstance.createProjectDnsRecord(projectId, dnsRecord);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectDnsRecord");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
DnsRecord *dnsRecord = ; // 

[apiInstance createProjectDnsRecordWith:projectId
    dnsRecord:dnsRecord
              completionHandler: ^(DnsRecord output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var dnsRecord = ; // {DnsRecord} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectDnsRecord(projectId, dnsRecord, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectDnsRecordExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var dnsRecord = new DnsRecord(); // DnsRecord | 

            try {
                DnsRecord result = apiInstance.createProjectDnsRecord(projectId, dnsRecord);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProjectDnsRecord: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$dnsRecord = ; // DnsRecord | 

try {
    $result = $api_instance->createProjectDnsRecord($projectId, $dnsRecord);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProjectDnsRecord: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $dnsRecord = WWW::OPenAPIClient::Object::DnsRecord->new(); # DnsRecord | 

eval {
    my $result = $api_instance->createProjectDnsRecord(projectId => $projectId, dnsRecord => $dnsRecord);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProjectDnsRecord: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
dnsRecord =  # DnsRecord | 

try:
    api_response = api_instance.create_project_dns_record(projectId, dnsRecord)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProjectDnsRecord: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let dnsRecord = ; // DnsRecord

    let mut context = ProjectApi::Context::default();
    let result = client.createProjectDnsRecord(projectId, dnsRecord, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
Body parameters
Name Description
dnsRecord *

DnsRecord payload.

Responses


createProjectRegionKawaii

Creates a new Kawaii.


/project/{projectId}/region/{regionId}/kawaii

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kawaii" \
 -d '{
  "ipsec_connections" : [ {
    "pre_shared_key" : "pre_shared_key",
    "phase1_dh_group_number" : 0,
    "phase1_encryption_algorithm" : "AES128",
    "phase2_encryption_algorithm" : "AES128",
    "ip" : "ip",
    "phase1_integrity_algorithm" : "SHA1",
    "phase1_lifetime" : "1h",
    "description" : "description",
    "dpd_timeout" : "240s",
    "dpd_timeout_action" : "restart",
    "start_action" : "start",
    "rekey_time" : "2h",
    "remote_ip" : "remote_ip",
    "phase2_lifetime" : "1h",
    "phase2_dh_group_number" : 6,
    "firewall" : {
      "ingress" : [ {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      } ],
      "egress_policy" : "accept",
      "egress" : [ {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      } ]
    },
    "name" : "name",
    "phase2_integrity_algorithm" : "SHA1",
    "remote_subnet" : "remote_subnet",
    "id" : "id"
  }, {
    "pre_shared_key" : "pre_shared_key",
    "phase1_dh_group_number" : 0,
    "phase1_encryption_algorithm" : "AES128",
    "phase2_encryption_algorithm" : "AES128",
    "ip" : "ip",
    "phase1_integrity_algorithm" : "SHA1",
    "phase1_lifetime" : "1h",
    "description" : "description",
    "dpd_timeout" : "240s",
    "dpd_timeout_action" : "restart",
    "start_action" : "start",
    "rekey_time" : "2h",
    "remote_ip" : "remote_ip",
    "phase2_lifetime" : "1h",
    "phase2_dh_group_number" : 6,
    "firewall" : {
      "ingress" : [ {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      } ],
      "egress_policy" : "accept",
      "egress" : [ {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      } ]
    },
    "name" : "name",
    "phase2_integrity_algorithm" : "SHA1",
    "remote_subnet" : "remote_subnet",
    "id" : "id"
  } ],
  "dnat" : [ {
    "protocol" : "tcp",
    "destination" : "destination",
    "ports" : "ports"
  }, {
    "protocol" : "tcp",
    "destination" : "destination",
    "ports" : "ports"
  } ],
  "firewall" : {
    "ingress" : [ {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    } ],
    "egress_policy" : "accept",
    "egress" : [ {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    } ]
  },
  "name" : "name",
  "description" : "description",
  "netip" : {
    "private" : [ "private", "private" ],
    "public" : [ "public", "public" ],
    "zones" : [ {
      "private" : "private",
      "public" : "public",
      "zone" : "zone"
    }, {
      "private" : "private",
      "public" : "public",
      "zone" : "zone"
    } ]
  },
  "id" : "id",
  "vpc_peerings" : [ {
    "subnet" : "subnet",
    "ingress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ],
    "netip" : [ {
      "private" : "private",
      "zone" : "zone"
    }, {
      "private" : "private",
      "zone" : "zone"
    } ],
    "policy" : "drop",
    "egress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ]
  }, {
    "subnet" : "subnet",
    "ingress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ],
    "netip" : [ {
      "private" : "private",
      "zone" : "zone"
    }, {
      "private" : "private",
      "zone" : "zone"
    } ],
    "policy" : "drop",
    "egress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kawaii kawaii = ; // Kawaii | 

        try {
            Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectRegionKawaii");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Kawaii kawaii = new Kawaii(); // Kawaii | 

try {
    final result = await api_instance.createProjectRegionKawaii(projectId, regionId, kawaii);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKawaii: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kawaii kawaii = ; // Kawaii | 

        try {
            Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectRegionKawaii");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Kawaii *kawaii = ; // 

[apiInstance createProjectRegionKawaiiWith:projectId
    regionId:regionId
    kawaii:kawaii
              completionHandler: ^(Kawaii output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var kawaii = ; // {Kawaii} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKawaii(projectId, regionId, kawaii, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKawaiiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var kawaii = new Kawaii(); // Kawaii | 

            try {
                Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProjectRegionKawaii: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$kawaii = ; // Kawaii | 

try {
    $result = $api_instance->createProjectRegionKawaii($projectId, $regionId, $kawaii);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProjectRegionKawaii: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $kawaii = WWW::OPenAPIClient::Object::Kawaii->new(); # Kawaii | 

eval {
    my $result = $api_instance->createProjectRegionKawaii(projectId => $projectId, regionId => $regionId, kawaii => $kawaii);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProjectRegionKawaii: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
kawaii =  # Kawaii | 

try:
    api_response = api_instance.create_project_region_kawaii(projectId, regionId, kawaii)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProjectRegionKawaii: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let kawaii = ; // Kawaii

    let mut context = ProjectApi::Context::default();
    let result = client.createProjectRegionKawaii(projectId, regionId, kawaii, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
kawaii *

Kawaii payload.

Responses


createProjectRegionKonvey

Creates a new Konvey (Kowabunga Network Load-Balancer).


/project/{projectId}/region/{regionId}/konvey

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/konvey" \
 -d '{
  "endpoints" : [ {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  }, {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  } ],
  "failover" : true,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vip" : "vip"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectRegionKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Konvey konvey = new Konvey(); // Konvey | 

try {
    final result = await api_instance.createProjectRegionKonvey(projectId, regionId, konvey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKonvey: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectRegionKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Konvey *konvey = ; // 

[apiInstance createProjectRegionKonveyWith:projectId
    regionId:regionId
    konvey:konvey
              completionHandler: ^(Konvey output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var konvey = ; // {Konvey} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKonvey(projectId, regionId, konvey, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var konvey = new Konvey(); // Konvey | 

            try {
                Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProjectRegionKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$konvey = ; // Konvey | 

try {
    $result = $api_instance->createProjectRegionKonvey($projectId, $regionId, $konvey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProjectRegionKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $konvey = WWW::OPenAPIClient::Object::Konvey->new(); # Konvey | 

eval {
    my $result = $api_instance->createProjectRegionKonvey(projectId => $projectId, regionId => $regionId, konvey => $konvey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProjectRegionKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
konvey =  # Konvey | 

try:
    api_response = api_instance.create_project_region_konvey(projectId, regionId, konvey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProjectRegionKonvey: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let konvey = ; // Konvey

    let mut context = ProjectApi::Context::default();
    let result = client.createProjectRegionKonvey(projectId, regionId, konvey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
konvey *

Konvey payload.

Responses


createProjectRegionKylo

Creates a new Kylo.


/project/{projectId}/region/{regionId}/kylo

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kylo?nfsId=nfsId_example" \
 -d '{
  "endpoint" : "endpoint",
  "access" : "RW",
  "size" : 6,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "protocols" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kylo kylo = ; // Kylo | 
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectRegionKylo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Kylo kylo = new Kylo(); // Kylo | 
final String nfsId = new String(); // String | NFS storage ID (optional, region's default if unspecified).

try {
    final result = await api_instance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKylo: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kylo kylo = ; // Kylo | 
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectRegionKylo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Kylo *kylo = ; // 
String *nfsId = nfsId_example; // NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance createProjectRegionKyloWith:projectId
    regionId:regionId
    kylo:kylo
    nfsId:nfsId
              completionHandler: ^(Kylo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var kylo = ; // {Kylo} 
var opts = {
  'nfsId': nfsId_example // {String} NFS storage ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKylo(projectId, regionId, kylo, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKyloExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var kylo = new Kylo(); // Kylo | 
            var nfsId = nfsId_example;  // String | NFS storage ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProjectRegionKylo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$kylo = ; // Kylo | 
$nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

try {
    $result = $api_instance->createProjectRegionKylo($projectId, $regionId, $kylo, $nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProjectRegionKylo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $kylo = WWW::OPenAPIClient::Object::Kylo->new(); # Kylo | 
my $nfsId = nfsId_example; # String | NFS storage ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->createProjectRegionKylo(projectId => $projectId, regionId => $regionId, kylo => $kylo, nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProjectRegionKylo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
kylo =  # Kylo | 
nfsId = nfsId_example # String | NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.create_project_region_kylo(projectId, regionId, kylo, nfsId=nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProjectRegionKylo: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let kylo = ; // Kylo
    let nfsId = nfsId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.createProjectRegionKylo(projectId, regionId, kylo, nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
kylo *

Kylo payload.

Query parameters
Name Description
nfsId
String
NFS storage ID (optional, region's default if unspecified).

Responses


createProjectRegionVolume

Creates a new storage volume.


/project/{projectId}/region/{regionId}/volume

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/volume?poolId=poolId_example&templateId=templateId_example" \
 -d '{
  "size" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "type" : "os"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Volume volume = ; // Volume | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

        try {
            Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectRegionVolume");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Volume volume = new Volume(); // Volume | 
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).
final String templateId = new String(); // String | Template to clone the storage volume from (optional, region's default if unspecified).

try {
    final result = await api_instance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionVolume: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Volume volume = ; // Volume | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

        try {
            Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectRegionVolume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Volume *volume = ; // 
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
String *templateId = templateId_example; // Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)

[apiInstance createProjectRegionVolumeWith:projectId
    regionId:regionId
    volume:volume
    poolId:poolId
    templateId:templateId
              completionHandler: ^(Volume output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var volume = ; // {Volume} 
var opts = {
  'poolId': poolId_example, // {String} Storage pool ID (optional, region's default if unspecified).
  'templateId': templateId_example // {String} Template to clone the storage volume from (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionVolume(projectId, regionId, volume, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionVolumeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var volume = new Volume(); // Volume | 
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)
            var templateId = templateId_example;  // String | Template to clone the storage volume from (optional, region's default if unspecified). (optional)  (default to null)

            try {
                Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProjectRegionVolume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$volume = ; // Volume | 
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
$templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

try {
    $result = $api_instance->createProjectRegionVolume($projectId, $regionId, $volume, $poolId, $templateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProjectRegionVolume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $volume = WWW::OPenAPIClient::Object::Volume->new(); # Volume | 
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).
my $templateId = templateId_example; # String | Template to clone the storage volume from (optional, region's default if unspecified).

eval {
    my $result = $api_instance->createProjectRegionVolume(projectId => $projectId, regionId => $regionId, volume => $volume, poolId => $poolId, templateId => $templateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProjectRegionVolume: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
volume =  # Volume | 
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
templateId = templateId_example # String | Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.create_project_region_volume(projectId, regionId, volume, poolId=poolId, templateId=templateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProjectRegionVolume: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let volume = ; // Volume
    let poolId = poolId_example; // String
    let templateId = templateId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
volume *

Volume payload.

Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).
templateId
String
Template to clone the storage volume from (optional, region's default if unspecified).

Responses


createProjectZoneInstance

Creates a new virtual machine instance.


/project/{projectId}/zone/{zoneId}/instance

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/instance" \
 -d '{
  "memory" : 0,
  "adapters" : [ "adapters", "adapters" ],
  "name" : "name",
  "volumes" : [ "volumes", "volumes" ],
  "description" : "description",
  "id" : "id",
  "vcpus" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Instance instance = ; // Instance | 

        try {
            Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectZoneInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Instance instance = new Instance(); // Instance | 

try {
    final result = await api_instance.createProjectZoneInstance(projectId, zoneId, instance);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneInstance: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Instance instance = ; // Instance | 

        try {
            Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectZoneInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Instance *instance = ; // 

[apiInstance createProjectZoneInstanceWith:projectId
    zoneId:zoneId
    instance:instance
              completionHandler: ^(Instance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var instance = ; // {Instance} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneInstance(projectId, zoneId, instance, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var instance = new Instance(); // Instance | 

            try {
                Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProjectZoneInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$instance = ; // Instance | 

try {
    $result = $api_instance->createProjectZoneInstance($projectId, $zoneId, $instance);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProjectZoneInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $instance = WWW::OPenAPIClient::Object::Instance->new(); # Instance | 

eval {
    my $result = $api_instance->createProjectZoneInstance(projectId => $projectId, zoneId => $zoneId, instance => $instance);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProjectZoneInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
instance =  # Instance | 

try:
    api_response = api_instance.create_project_zone_instance(projectId, zoneId, instance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProjectZoneInstance: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let instance = ; // Instance

    let mut context = ProjectApi::Context::default();
    let result = client.createProjectZoneInstance(projectId, zoneId, instance, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
instance *

Instance payload.

Responses


createProjectZoneKompute

Creates a new Kompute.


/project/{projectId}/zone/{zoneId}/kompute

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/kompute?poolId=poolId_example&templateId=templateId_example&public=true" \
 -d '{
  "disk" : 1,
  "data_disk" : 5,
  "memory" : 0,
  "ip" : "ip",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vcpus" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kompute kompute = ; // Kompute | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
        Boolean public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

        try {
            Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectZoneKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Kompute kompute = new Kompute(); // Kompute | 
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).
final String templateId = new String(); // String | Template to clone the storage volume from (optional, region's default if unspecified).
final Boolean public = new Boolean(); // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

try {
    final result = await api_instance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneKompute: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kompute kompute = ; // Kompute | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
        Boolean public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

        try {
            Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectZoneKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Kompute *kompute = ; // 
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
String *templateId = templateId_example; // Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)
Boolean *public = true; // Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional) (default to null)

[apiInstance createProjectZoneKomputeWith:projectId
    zoneId:zoneId
    kompute:kompute
    poolId:poolId
    templateId:templateId
    public:public
              completionHandler: ^(Kompute output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var kompute = ; // {Kompute} 
var opts = {
  'poolId': poolId_example, // {String} Storage pool ID (optional, region's default if unspecified).
  'templateId': templateId_example, // {String} Template to clone the storage volume from (optional, region's default if unspecified).
  'public': true // {Boolean} Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneKompute(projectId, zoneId, kompute, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var kompute = new Kompute(); // Kompute | 
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)
            var templateId = templateId_example;  // String | Template to clone the storage volume from (optional, region's default if unspecified). (optional)  (default to null)
            var public = true;  // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional)  (default to null)

            try {
                Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProjectZoneKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$kompute = ; // Kompute | 
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
$templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
$public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

try {
    $result = $api_instance->createProjectZoneKompute($projectId, $zoneId, $kompute, $poolId, $templateId, $public);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProjectZoneKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $kompute = WWW::OPenAPIClient::Object::Kompute->new(); # Kompute | 
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).
my $templateId = templateId_example; # String | Template to clone the storage volume from (optional, region's default if unspecified).
my $public = true; # Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

eval {
    my $result = $api_instance->createProjectZoneKompute(projectId => $projectId, zoneId => $zoneId, kompute => $kompute, poolId => $poolId, templateId => $templateId, public => $public);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProjectZoneKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
kompute =  # Kompute | 
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
templateId = templateId_example # String | Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)
public = true # Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional) (default to null)

try:
    api_response = api_instance.create_project_zone_kompute(projectId, zoneId, kompute, poolId=poolId, templateId=templateId, public=public)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProjectZoneKompute: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let kompute = ; // Kompute
    let poolId = poolId_example; // String
    let templateId = templateId_example; // String
    let public = true; // Boolean

    let mut context = ProjectApi::Context::default();
    let result = client.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
kompute *

Kompute payload.

Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).
templateId
String
Template to clone the storage volume from (optional, region's default if unspecified).
public
Boolean
Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

Responses


createProjectZoneKonvey

Creates a new Konvey (Kowabunga Network Load-Balancer).


/project/{projectId}/zone/{zoneId}/konvey

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/konvey" \
 -d '{
  "endpoints" : [ {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  }, {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  } ],
  "failover" : true,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vip" : "vip"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectZoneKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Konvey konvey = new Konvey(); // Konvey | 

try {
    final result = await api_instance.createProjectZoneKonvey(projectId, zoneId, konvey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneKonvey: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#createProjectZoneKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Konvey *konvey = ; // 

[apiInstance createProjectZoneKonveyWith:projectId
    zoneId:zoneId
    konvey:konvey
              completionHandler: ^(Konvey output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var konvey = ; // {Konvey} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneKonvey(projectId, zoneId, konvey, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var konvey = new Konvey(); // Konvey | 

            try {
                Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.createProjectZoneKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$konvey = ; // Konvey | 

try {
    $result = $api_instance->createProjectZoneKonvey($projectId, $zoneId, $konvey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->createProjectZoneKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $konvey = WWW::OPenAPIClient::Object::Konvey->new(); # Konvey | 

eval {
    my $result = $api_instance->createProjectZoneKonvey(projectId => $projectId, zoneId => $zoneId, konvey => $konvey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->createProjectZoneKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
konvey =  # Konvey | 

try:
    api_response = api_instance.create_project_zone_konvey(projectId, zoneId, konvey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->createProjectZoneKonvey: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let konvey = ; // Konvey

    let mut context = ProjectApi::Context::default();
    let result = client.createProjectZoneKonvey(projectId, zoneId, konvey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
konvey *

Konvey payload.

Responses


deleteProject

Deletes an existing project.


/project/{projectId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            apiInstance.deleteProject(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.

try {
    final result = await api_instance.deleteProject(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteProject: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            apiInstance.deleteProject(projectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#deleteProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)

[apiInstance deleteProjectWith:projectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProject(projectId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteProjectExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)

            try {
                apiInstance.deleteProject(projectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.deleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.

try {
    $api_instance->deleteProject($projectId);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.

eval {
    $api_instance->deleteProject(projectId => $projectId);
};
if ($@) {
    warn "Exception when calling ProjectApi->deleteProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)

try:
    api_instance.delete_project(projectId)
except ApiException as e:
    print("Exception when calling ProjectApi->deleteProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.deleteProject(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required

Responses


listProjectDnsRecords

Returns the IDs of DNS record objects.


/project/{projectId}/records

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/records"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            array['String'] result = apiInstance.listProjectDnsRecords(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectDnsRecords");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.

try {
    final result = await api_instance.listProjectDnsRecords(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectDnsRecords: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            array['String'] result = apiInstance.listProjectDnsRecords(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectDnsRecords");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)

[apiInstance listProjectDnsRecordsWith:projectId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectDnsRecords(projectId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectDnsRecordsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)

            try {
                array['String'] result = apiInstance.listProjectDnsRecords(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjectDnsRecords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.

try {
    $result = $api_instance->listProjectDnsRecords($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjectDnsRecords: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.

eval {
    my $result = $api_instance->listProjectDnsRecords(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjectDnsRecords: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)

try:
    api_response = api_instance.list_project_dns_records(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjectDnsRecords: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.listProjectDnsRecords(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required

Responses


listProjectRegionKawaiis

Returns the IDs of Kawaii objects.


/project/{projectId}/region/{regionId}/kawaiis

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kawaiis"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectRegionKawaiis");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionKawaiis(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKawaiis: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectRegionKawaiis");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionKawaiisWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKawaiis(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKawaiisExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjectRegionKawaiis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionKawaiis($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjectRegionKawaiis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionKawaiis(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjectRegionKawaiis: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_kawaiis(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjectRegionKawaiis: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.listProjectRegionKawaiis(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


listProjectRegionKonveys

Returns the IDs of Konvey (Kowabunga Network Load-Balancer) objects.


/project/{projectId}/region/{regionId}/konveys

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/konveys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectRegionKonveys");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionKonveys(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKonveys: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectRegionKonveys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionKonveysWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKonveys(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKonveysExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjectRegionKonveys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionKonveys($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjectRegionKonveys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionKonveys(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjectRegionKonveys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_konveys(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjectRegionKonveys: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.listProjectRegionKonveys(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


listProjectRegionKylos

Returns the IDs of Kylo objects.


/project/{projectId}/region/{regionId}/kylo

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kylo?nfsId=nfsId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectRegionKylos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final String nfsId = new String(); // String | NFS storage ID (optional, region's default if unspecified).

try {
    final result = await api_instance.listProjectRegionKylos(projectId, regionId, nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKylos: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectRegionKylos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
String *nfsId = nfsId_example; // NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance listProjectRegionKylosWith:projectId
    regionId:regionId
    nfsId:nfsId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var opts = {
  'nfsId': nfsId_example // {String} NFS storage ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKylos(projectId, regionId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKylosExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var nfsId = nfsId_example;  // String | NFS storage ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjectRegionKylos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

try {
    $result = $api_instance->listProjectRegionKylos($projectId, $regionId, $nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjectRegionKylos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $nfsId = nfsId_example; # String | NFS storage ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->listProjectRegionKylos(projectId => $projectId, regionId => $regionId, nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjectRegionKylos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
nfsId = nfsId_example # String | NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.list_project_region_kylos(projectId, regionId, nfsId=nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjectRegionKylos: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let nfsId = nfsId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.listProjectRegionKylos(projectId, regionId, nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Query parameters
Name Description
nfsId
String
NFS storage ID (optional, region's default if unspecified).

Responses


listProjectRegionVolumes

Returns the IDs of storage volume objects.


/project/{projectId}/region/{regionId}/volumes

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/volumes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectRegionVolumes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionVolumes(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionVolumes: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectRegionVolumes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionVolumesWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionVolumes(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionVolumesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjectRegionVolumes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionVolumes($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjectRegionVolumes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionVolumes(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjectRegionVolumes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_volumes(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjectRegionVolumes: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.listProjectRegionVolumes(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


listProjectZoneInstances

Returns the IDs of virtual machine instance objects.


/project/{projectId}/zone/{zoneId}/instances

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/instances"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectZoneInstances");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneInstances(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneInstances: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectZoneInstances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneInstancesWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneInstances(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneInstancesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjectZoneInstances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneInstances($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjectZoneInstances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneInstances(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjectZoneInstances: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_instances(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjectZoneInstances: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.listProjectZoneInstances(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


listProjectZoneKomputes

Returns the IDs of Kompute objects.


/project/{projectId}/zone/{zoneId}/komputes

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/komputes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectZoneKomputes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneKomputes(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneKomputes: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectZoneKomputes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneKomputesWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneKomputes(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneKomputesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjectZoneKomputes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneKomputes($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjectZoneKomputes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneKomputes(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjectZoneKomputes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_komputes(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjectZoneKomputes: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.listProjectZoneKomputes(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


listProjectZoneKonveys

Returns the IDs of Konvey (Kowabunga Network Load-Balancer) objects.


/project/{projectId}/zone/{zoneId}/konveys

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/konveys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectZoneKonveys");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneKonveys(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneKonveys: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjectZoneKonveys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneKonveysWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneKonveys(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneKonveysExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjectZoneKonveys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneKonveys($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjectZoneKonveys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneKonveys(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjectZoneKonveys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_konveys(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjectZoneKonveys: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.listProjectZoneKonveys(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


listProjects

Returns the IDs of project objects.


/project

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project?subnetSize=56"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        Integer subnetSize = 56; // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

        try {
            array['String'] result = apiInstance.listProjects(subnetSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjects");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer subnetSize = new Integer(); // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

try {
    final result = await api_instance.listProjects(subnetSize);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjects: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        Integer subnetSize = 56; // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

        try {
            array['String'] result = apiInstance.listProjects(subnetSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#listProjects");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
Integer *subnetSize = 56; // The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later. (optional) (default to null)

[apiInstance listProjectsWith:subnetSize
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var opts = {
  'subnetSize': 56 // {Integer} The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjects(opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var subnetSize = 56;  // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later. (optional)  (default to null)

            try {
                array['String'] result = apiInstance.listProjects(subnetSize);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.listProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$subnetSize = 56; // Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

try {
    $result = $api_instance->listProjects($subnetSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->listProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $subnetSize = 56; # Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

eval {
    my $result = $api_instance->listProjects(subnetSize => $subnetSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->listProjects: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
subnetSize = 56 # Integer | The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later. (optional) (default to null)

try:
    api_response = api_instance.list_projects(subnetSize=subnetSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->listProjects: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let subnetSize = 56; // Integer

    let mut context = ProjectApi::Context::default();
    let result = client.listProjects(subnetSize, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
subnetSize
Integer
The minimum VPC subnet size to be affected to the project. WARNING, this cannot be changed later.

Responses


readProject

Returns a project.


/project/{projectId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            Project result = apiInstance.readProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#readProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.

try {
    final result = await api_instance.readProject(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readProject: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            Project result = apiInstance.readProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#readProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)

[apiInstance readProjectWith:projectId
              completionHandler: ^(Project output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readProject(projectId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readProjectExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)

            try {
                Project result = apiInstance.readProject(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.readProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.

try {
    $result = $api_instance->readProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->readProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.

eval {
    my $result = $api_instance->readProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->readProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)

try:
    api_response = api_instance.read_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->readProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.readProject(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required

Responses


readProjectCost

Returns a resource cost.


/project/{projectId}/cost

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/cost"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            Cost result = apiInstance.readProjectCost(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#readProjectCost");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.

try {
    final result = await api_instance.readProjectCost(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readProjectCost: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            Cost result = apiInstance.readProjectCost(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#readProjectCost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)

[apiInstance readProjectCostWith:projectId
              completionHandler: ^(Cost output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readProjectCost(projectId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readProjectCostExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)

            try {
                Cost result = apiInstance.readProjectCost(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.readProjectCost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.

try {
    $result = $api_instance->readProjectCost($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->readProjectCost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.

eval {
    my $result = $api_instance->readProjectCost(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->readProjectCost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)

try:
    api_response = api_instance.read_project_cost(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->readProjectCost: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.readProjectCost(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required

Responses


readProjectUsage

Returns a global project resource quotas/usage (0 for unlimited).


/project/{projectId}/usage

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/usage"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            ProjectResources result = apiInstance.readProjectUsage(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#readProjectUsage");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.

try {
    final result = await api_instance.readProjectUsage(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readProjectUsage: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            ProjectResources result = apiInstance.readProjectUsage(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#readProjectUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)

[apiInstance readProjectUsageWith:projectId
              completionHandler: ^(ProjectResources output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readProjectUsage(projectId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readProjectUsageExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)

            try {
                ProjectResources result = apiInstance.readProjectUsage(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.readProjectUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.

try {
    $result = $api_instance->readProjectUsage($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->readProjectUsage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.

eval {
    my $result = $api_instance->readProjectUsage(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->readProjectUsage: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)

try:
    api_response = api_instance.read_project_usage(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->readProjectUsage: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = ProjectApi::Context::default();
    let result = client.readProjectUsage(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required

Responses


updateProject

Updates a project configuration.


/project/{projectId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}" \
 -d '{
  "quotas" : {
    "memory" : 6,
    "instances" : 5,
    "storage" : 1,
    "vcpus" : 0
  },
  "regions" : [ "regions", "regions" ],
  "teams" : [ "teams", "teams" ],
  "metadatas" : [ {
    "value" : "value",
    "key" : "key"
  }, {
    "value" : "value",
    "key" : "key"
  } ],
  "root_password" : "root_password",
  "description" : "description",
  "bootstrap_user" : "bootstrap_user",
  "tags" : [ "tags", "tags" ],
  "reserved_vrrp_ids" : [ 5, 5 ],
  "bootstrap_pubkey" : "bootstrap_pubkey",
  "private_subnets" : [ {
    "value" : "value",
    "key" : "key"
  }, {
    "value" : "value",
    "key" : "key"
  } ],
  "domain" : "domain",
  "name" : "name",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectApi;

import java.io.File;
import java.util.*;

public class ProjectApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        Project project = ; // Project | 

        try {
            Project result = apiInstance.updateProject(projectId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#updateProject");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final Project project = new Project(); // Project | 

try {
    final result = await api_instance.updateProject(projectId, project);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateProject: $e\n');
}

import org.openapitools.client.api.ProjectApi;

public class ProjectApiExample {
    public static void main(String[] args) {
        ProjectApi apiInstance = new ProjectApi();
        String projectId = projectId_example; // String | The ID of the project.
        Project project = ; // Project | 

        try {
            Project result = apiInstance.updateProject(projectId, project);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectApi#updateProject");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ProjectApi *apiInstance = [[ProjectApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
Project *project = ; // 

[apiInstance updateProjectWith:projectId
    project:project
              completionHandler: ^(Project output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ProjectApi()
var projectId = projectId_example; // {String} The ID of the project.
var project = ; // {Project} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProject(projectId, project, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateProjectExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ProjectApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var project = new Project(); // Project | 

            try {
                Project result = apiInstance.updateProject(projectId, project);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectApi.updateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectApi();
$projectId = projectId_example; // String | The ID of the project.
$project = ; // Project | 

try {
    $result = $api_instance->updateProject($projectId, $project);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectApi->updateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $project = WWW::OPenAPIClient::Object::Project->new(); # Project | 

eval {
    my $result = $api_instance->updateProject(projectId => $projectId, project => $project);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectApi->updateProject: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ProjectApi()
projectId = projectId_example # String | The ID of the project. (default to null)
project =  # Project | 

try:
    api_response = api_instance.update_project(projectId, project)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectApi->updateProject: %s\n" % e)
extern crate ProjectApi;

pub fn main() {
    let projectId = projectId_example; // String
    let project = ; // Project

    let mut context = ProjectApi::Context::default();
    let result = client.updateProject(projectId, project, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
Body parameters
Name Description
project *

Project payload.

Responses


Record

createProjectDnsRecord

Creates a new DNS record.


/project/{projectId}/record

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/record" \
 -d '{
  "addresses" : [ "addresses", "addresses" ],
  "domain" : "domain",
  "name" : "name",
  "description" : "description",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecordApi;

import java.io.File;
import java.util.*;

public class RecordApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RecordApi apiInstance = new RecordApi();
        String projectId = projectId_example; // String | The ID of the project.
        DnsRecord dnsRecord = ; // DnsRecord | 

        try {
            DnsRecord result = apiInstance.createProjectDnsRecord(projectId, dnsRecord);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#createProjectDnsRecord");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final DnsRecord dnsRecord = new DnsRecord(); // DnsRecord | 

try {
    final result = await api_instance.createProjectDnsRecord(projectId, dnsRecord);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectDnsRecord: $e\n');
}

import org.openapitools.client.api.RecordApi;

public class RecordApiExample {
    public static void main(String[] args) {
        RecordApi apiInstance = new RecordApi();
        String projectId = projectId_example; // String | The ID of the project.
        DnsRecord dnsRecord = ; // DnsRecord | 

        try {
            DnsRecord result = apiInstance.createProjectDnsRecord(projectId, dnsRecord);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#createProjectDnsRecord");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RecordApi *apiInstance = [[RecordApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
DnsRecord *dnsRecord = ; // 

[apiInstance createProjectDnsRecordWith:projectId
    dnsRecord:dnsRecord
              completionHandler: ^(DnsRecord output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RecordApi()
var projectId = projectId_example; // {String} The ID of the project.
var dnsRecord = ; // {DnsRecord} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectDnsRecord(projectId, dnsRecord, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectDnsRecordExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RecordApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var dnsRecord = new DnsRecord(); // DnsRecord | 

            try {
                DnsRecord result = apiInstance.createProjectDnsRecord(projectId, dnsRecord);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecordApi.createProjectDnsRecord: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecordApi();
$projectId = projectId_example; // String | The ID of the project.
$dnsRecord = ; // DnsRecord | 

try {
    $result = $api_instance->createProjectDnsRecord($projectId, $dnsRecord);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordApi->createProjectDnsRecord: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecordApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecordApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $dnsRecord = WWW::OPenAPIClient::Object::DnsRecord->new(); # DnsRecord | 

eval {
    my $result = $api_instance->createProjectDnsRecord(projectId => $projectId, dnsRecord => $dnsRecord);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecordApi->createProjectDnsRecord: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RecordApi()
projectId = projectId_example # String | The ID of the project. (default to null)
dnsRecord =  # DnsRecord | 

try:
    api_response = api_instance.create_project_dns_record(projectId, dnsRecord)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordApi->createProjectDnsRecord: %s\n" % e)
extern crate RecordApi;

pub fn main() {
    let projectId = projectId_example; // String
    let dnsRecord = ; // DnsRecord

    let mut context = RecordApi::Context::default();
    let result = client.createProjectDnsRecord(projectId, dnsRecord, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
Body parameters
Name Description
dnsRecord *

DnsRecord payload.

Responses


deleteDnsRecord

Deletes an existing DNS record.


/record/{recordId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/record/{recordId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecordApi;

import java.io.File;
import java.util.*;

public class RecordApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RecordApi apiInstance = new RecordApi();
        String recordId = recordId_example; // String | The ID of the DNS record.

        try {
            apiInstance.deleteDnsRecord(recordId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#deleteDnsRecord");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String recordId = new String(); // String | The ID of the DNS record.

try {
    final result = await api_instance.deleteDnsRecord(recordId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteDnsRecord: $e\n');
}

import org.openapitools.client.api.RecordApi;

public class RecordApiExample {
    public static void main(String[] args) {
        RecordApi apiInstance = new RecordApi();
        String recordId = recordId_example; // String | The ID of the DNS record.

        try {
            apiInstance.deleteDnsRecord(recordId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#deleteDnsRecord");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RecordApi *apiInstance = [[RecordApi alloc] init];
String *recordId = recordId_example; // The ID of the DNS record. (default to null)

[apiInstance deleteDnsRecordWith:recordId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RecordApi()
var recordId = recordId_example; // {String} The ID of the DNS record.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteDnsRecord(recordId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteDnsRecordExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RecordApi();
            var recordId = recordId_example;  // String | The ID of the DNS record. (default to null)

            try {
                apiInstance.deleteDnsRecord(recordId);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecordApi.deleteDnsRecord: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecordApi();
$recordId = recordId_example; // String | The ID of the DNS record.

try {
    $api_instance->deleteDnsRecord($recordId);
} catch (Exception $e) {
    echo 'Exception when calling RecordApi->deleteDnsRecord: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecordApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecordApi->new();
my $recordId = recordId_example; # String | The ID of the DNS record.

eval {
    $api_instance->deleteDnsRecord(recordId => $recordId);
};
if ($@) {
    warn "Exception when calling RecordApi->deleteDnsRecord: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RecordApi()
recordId = recordId_example # String | The ID of the DNS record. (default to null)

try:
    api_instance.delete_dns_record(recordId)
except ApiException as e:
    print("Exception when calling RecordApi->deleteDnsRecord: %s\n" % e)
extern crate RecordApi;

pub fn main() {
    let recordId = recordId_example; // String

    let mut context = RecordApi::Context::default();
    let result = client.deleteDnsRecord(recordId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
recordId*
String
The ID of the DNS record.
Required

Responses


listProjectDnsRecords

Returns the IDs of DNS record objects.


/project/{projectId}/records

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/records"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecordApi;

import java.io.File;
import java.util.*;

public class RecordApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RecordApi apiInstance = new RecordApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            array['String'] result = apiInstance.listProjectDnsRecords(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#listProjectDnsRecords");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.

try {
    final result = await api_instance.listProjectDnsRecords(projectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectDnsRecords: $e\n');
}

import org.openapitools.client.api.RecordApi;

public class RecordApiExample {
    public static void main(String[] args) {
        RecordApi apiInstance = new RecordApi();
        String projectId = projectId_example; // String | The ID of the project.

        try {
            array['String'] result = apiInstance.listProjectDnsRecords(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#listProjectDnsRecords");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RecordApi *apiInstance = [[RecordApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)

[apiInstance listProjectDnsRecordsWith:projectId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RecordApi()
var projectId = projectId_example; // {String} The ID of the project.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectDnsRecords(projectId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectDnsRecordsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RecordApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)

            try {
                array['String'] result = apiInstance.listProjectDnsRecords(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecordApi.listProjectDnsRecords: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecordApi();
$projectId = projectId_example; // String | The ID of the project.

try {
    $result = $api_instance->listProjectDnsRecords($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordApi->listProjectDnsRecords: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecordApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecordApi->new();
my $projectId = projectId_example; # String | The ID of the project.

eval {
    my $result = $api_instance->listProjectDnsRecords(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecordApi->listProjectDnsRecords: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RecordApi()
projectId = projectId_example # String | The ID of the project. (default to null)

try:
    api_response = api_instance.list_project_dns_records(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordApi->listProjectDnsRecords: %s\n" % e)
extern crate RecordApi;

pub fn main() {
    let projectId = projectId_example; // String

    let mut context = RecordApi::Context::default();
    let result = client.listProjectDnsRecords(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required

Responses


readDnsRecord

Returns a DNS record.


/record/{recordId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/record/{recordId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecordApi;

import java.io.File;
import java.util.*;

public class RecordApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RecordApi apiInstance = new RecordApi();
        String recordId = recordId_example; // String | The ID of the DNS record.

        try {
            DnsRecord result = apiInstance.readDnsRecord(recordId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#readDnsRecord");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String recordId = new String(); // String | The ID of the DNS record.

try {
    final result = await api_instance.readDnsRecord(recordId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readDnsRecord: $e\n');
}

import org.openapitools.client.api.RecordApi;

public class RecordApiExample {
    public static void main(String[] args) {
        RecordApi apiInstance = new RecordApi();
        String recordId = recordId_example; // String | The ID of the DNS record.

        try {
            DnsRecord result = apiInstance.readDnsRecord(recordId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#readDnsRecord");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RecordApi *apiInstance = [[RecordApi alloc] init];
String *recordId = recordId_example; // The ID of the DNS record. (default to null)

[apiInstance readDnsRecordWith:recordId
              completionHandler: ^(DnsRecord output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RecordApi()
var recordId = recordId_example; // {String} The ID of the DNS record.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readDnsRecord(recordId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readDnsRecordExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RecordApi();
            var recordId = recordId_example;  // String | The ID of the DNS record. (default to null)

            try {
                DnsRecord result = apiInstance.readDnsRecord(recordId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecordApi.readDnsRecord: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecordApi();
$recordId = recordId_example; // String | The ID of the DNS record.

try {
    $result = $api_instance->readDnsRecord($recordId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordApi->readDnsRecord: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecordApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecordApi->new();
my $recordId = recordId_example; # String | The ID of the DNS record.

eval {
    my $result = $api_instance->readDnsRecord(recordId => $recordId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecordApi->readDnsRecord: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RecordApi()
recordId = recordId_example # String | The ID of the DNS record. (default to null)

try:
    api_response = api_instance.read_dns_record(recordId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordApi->readDnsRecord: %s\n" % e)
extern crate RecordApi;

pub fn main() {
    let recordId = recordId_example; // String

    let mut context = RecordApi::Context::default();
    let result = client.readDnsRecord(recordId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
recordId*
String
The ID of the DNS record.
Required

Responses


updateDnsRecord

Updates a DNS record configuration.


/record/{recordId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/record/{recordId}" \
 -d '{
  "addresses" : [ "addresses", "addresses" ],
  "domain" : "domain",
  "name" : "name",
  "description" : "description",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RecordApi;

import java.io.File;
import java.util.*;

public class RecordApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RecordApi apiInstance = new RecordApi();
        String recordId = recordId_example; // String | The ID of the DNS record.
        DnsRecord dnsRecord = ; // DnsRecord | 

        try {
            DnsRecord result = apiInstance.updateDnsRecord(recordId, dnsRecord);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#updateDnsRecord");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String recordId = new String(); // String | The ID of the DNS record.
final DnsRecord dnsRecord = new DnsRecord(); // DnsRecord | 

try {
    final result = await api_instance.updateDnsRecord(recordId, dnsRecord);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateDnsRecord: $e\n');
}

import org.openapitools.client.api.RecordApi;

public class RecordApiExample {
    public static void main(String[] args) {
        RecordApi apiInstance = new RecordApi();
        String recordId = recordId_example; // String | The ID of the DNS record.
        DnsRecord dnsRecord = ; // DnsRecord | 

        try {
            DnsRecord result = apiInstance.updateDnsRecord(recordId, dnsRecord);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordApi#updateDnsRecord");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RecordApi *apiInstance = [[RecordApi alloc] init];
String *recordId = recordId_example; // The ID of the DNS record. (default to null)
DnsRecord *dnsRecord = ; // 

[apiInstance updateDnsRecordWith:recordId
    dnsRecord:dnsRecord
              completionHandler: ^(DnsRecord output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RecordApi()
var recordId = recordId_example; // {String} The ID of the DNS record.
var dnsRecord = ; // {DnsRecord} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDnsRecord(recordId, dnsRecord, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateDnsRecordExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RecordApi();
            var recordId = recordId_example;  // String | The ID of the DNS record. (default to null)
            var dnsRecord = new DnsRecord(); // DnsRecord | 

            try {
                DnsRecord result = apiInstance.updateDnsRecord(recordId, dnsRecord);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RecordApi.updateDnsRecord: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RecordApi();
$recordId = recordId_example; // String | The ID of the DNS record.
$dnsRecord = ; // DnsRecord | 

try {
    $result = $api_instance->updateDnsRecord($recordId, $dnsRecord);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordApi->updateDnsRecord: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RecordApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RecordApi->new();
my $recordId = recordId_example; # String | The ID of the DNS record.
my $dnsRecord = WWW::OPenAPIClient::Object::DnsRecord->new(); # DnsRecord | 

eval {
    my $result = $api_instance->updateDnsRecord(recordId => $recordId, dnsRecord => $dnsRecord);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RecordApi->updateDnsRecord: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RecordApi()
recordId = recordId_example # String | The ID of the DNS record. (default to null)
dnsRecord =  # DnsRecord | 

try:
    api_response = api_instance.update_dns_record(recordId, dnsRecord)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RecordApi->updateDnsRecord: %s\n" % e)
extern crate RecordApi;

pub fn main() {
    let recordId = recordId_example; // String
    let dnsRecord = ; // DnsRecord

    let mut context = RecordApi::Context::default();
    let result = client.updateDnsRecord(recordId, dnsRecord, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
recordId*
String
The ID of the DNS record.
Required
Body parameters
Name Description
dnsRecord *

DnsRecord payload.

Responses


Region

createKiwi

Creates a new Kiwi (Kowabunga Inner Wan Interface) provides edge-network services..


/region/{regionId}/kiwi

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/kiwi" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        Kiwi kiwi = ; // Kiwi | 

        try {
            Kiwi result = apiInstance.createKiwi(regionId, kiwi);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createKiwi");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final Kiwi kiwi = new Kiwi(); // Kiwi | 

try {
    final result = await api_instance.createKiwi(regionId, kiwi);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createKiwi: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        Kiwi kiwi = ; // Kiwi | 

        try {
            Kiwi result = apiInstance.createKiwi(regionId, kiwi);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createKiwi");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
Kiwi *kiwi = ; // 

[apiInstance createKiwiWith:regionId
    kiwi:kiwi
              completionHandler: ^(Kiwi output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var kiwi = ; // {Kiwi} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createKiwi(regionId, kiwi, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createKiwiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var kiwi = new Kiwi(); // Kiwi | 

            try {
                Kiwi result = apiInstance.createKiwi(regionId, kiwi);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createKiwi: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$kiwi = ; // Kiwi | 

try {
    $result = $api_instance->createKiwi($regionId, $kiwi);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createKiwi: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $kiwi = WWW::OPenAPIClient::Object::Kiwi->new(); # Kiwi | 

eval {
    my $result = $api_instance->createKiwi(regionId => $regionId, kiwi => $kiwi);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createKiwi: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
kiwi =  # Kiwi | 

try:
    api_response = api_instance.create_kiwi(regionId, kiwi)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createKiwi: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let kiwi = ; // Kiwi

    let mut context = RegionApi::Context::default();
    let result = client.createKiwi(regionId, kiwi, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
kiwi *

Kiwi payload.

Responses


createProjectRegionKawaii

Creates a new Kawaii.


/project/{projectId}/region/{regionId}/kawaii

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kawaii" \
 -d '{
  "ipsec_connections" : [ {
    "pre_shared_key" : "pre_shared_key",
    "phase1_dh_group_number" : 0,
    "phase1_encryption_algorithm" : "AES128",
    "phase2_encryption_algorithm" : "AES128",
    "ip" : "ip",
    "phase1_integrity_algorithm" : "SHA1",
    "phase1_lifetime" : "1h",
    "description" : "description",
    "dpd_timeout" : "240s",
    "dpd_timeout_action" : "restart",
    "start_action" : "start",
    "rekey_time" : "2h",
    "remote_ip" : "remote_ip",
    "phase2_lifetime" : "1h",
    "phase2_dh_group_number" : 6,
    "firewall" : {
      "ingress" : [ {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      } ],
      "egress_policy" : "accept",
      "egress" : [ {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      } ]
    },
    "name" : "name",
    "phase2_integrity_algorithm" : "SHA1",
    "remote_subnet" : "remote_subnet",
    "id" : "id"
  }, {
    "pre_shared_key" : "pre_shared_key",
    "phase1_dh_group_number" : 0,
    "phase1_encryption_algorithm" : "AES128",
    "phase2_encryption_algorithm" : "AES128",
    "ip" : "ip",
    "phase1_integrity_algorithm" : "SHA1",
    "phase1_lifetime" : "1h",
    "description" : "description",
    "dpd_timeout" : "240s",
    "dpd_timeout_action" : "restart",
    "start_action" : "start",
    "rekey_time" : "2h",
    "remote_ip" : "remote_ip",
    "phase2_lifetime" : "1h",
    "phase2_dh_group_number" : 6,
    "firewall" : {
      "ingress" : [ {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "source" : "0.0.0.0/0",
        "ports" : "ports"
      } ],
      "egress_policy" : "accept",
      "egress" : [ {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      }, {
        "protocol" : "tcp",
        "destination" : "0.0.0.0/0",
        "ports" : "ports"
      } ]
    },
    "name" : "name",
    "phase2_integrity_algorithm" : "SHA1",
    "remote_subnet" : "remote_subnet",
    "id" : "id"
  } ],
  "dnat" : [ {
    "protocol" : "tcp",
    "destination" : "destination",
    "ports" : "ports"
  }, {
    "protocol" : "tcp",
    "destination" : "destination",
    "ports" : "ports"
  } ],
  "firewall" : {
    "ingress" : [ {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "source" : "0.0.0.0/0",
      "ports" : "ports"
    } ],
    "egress_policy" : "accept",
    "egress" : [ {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "destination" : "0.0.0.0/0",
      "ports" : "ports"
    } ]
  },
  "name" : "name",
  "description" : "description",
  "netip" : {
    "private" : [ "private", "private" ],
    "public" : [ "public", "public" ],
    "zones" : [ {
      "private" : "private",
      "public" : "public",
      "zone" : "zone"
    }, {
      "private" : "private",
      "public" : "public",
      "zone" : "zone"
    } ]
  },
  "id" : "id",
  "vpc_peerings" : [ {
    "subnet" : "subnet",
    "ingress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ],
    "netip" : [ {
      "private" : "private",
      "zone" : "zone"
    }, {
      "private" : "private",
      "zone" : "zone"
    } ],
    "policy" : "drop",
    "egress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ]
  }, {
    "subnet" : "subnet",
    "ingress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ],
    "netip" : [ {
      "private" : "private",
      "zone" : "zone"
    }, {
      "private" : "private",
      "zone" : "zone"
    } ],
    "policy" : "drop",
    "egress" : [ {
      "protocol" : "tcp",
      "ports" : "ports"
    }, {
      "protocol" : "tcp",
      "ports" : "ports"
    } ]
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kawaii kawaii = ; // Kawaii | 

        try {
            Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createProjectRegionKawaii");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Kawaii kawaii = new Kawaii(); // Kawaii | 

try {
    final result = await api_instance.createProjectRegionKawaii(projectId, regionId, kawaii);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKawaii: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kawaii kawaii = ; // Kawaii | 

        try {
            Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createProjectRegionKawaii");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Kawaii *kawaii = ; // 

[apiInstance createProjectRegionKawaiiWith:projectId
    regionId:regionId
    kawaii:kawaii
              completionHandler: ^(Kawaii output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var kawaii = ; // {Kawaii} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKawaii(projectId, regionId, kawaii, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKawaiiExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var kawaii = new Kawaii(); // Kawaii | 

            try {
                Kawaii result = apiInstance.createProjectRegionKawaii(projectId, regionId, kawaii);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createProjectRegionKawaii: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$kawaii = ; // Kawaii | 

try {
    $result = $api_instance->createProjectRegionKawaii($projectId, $regionId, $kawaii);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createProjectRegionKawaii: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $kawaii = WWW::OPenAPIClient::Object::Kawaii->new(); # Kawaii | 

eval {
    my $result = $api_instance->createProjectRegionKawaii(projectId => $projectId, regionId => $regionId, kawaii => $kawaii);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createProjectRegionKawaii: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
kawaii =  # Kawaii | 

try:
    api_response = api_instance.create_project_region_kawaii(projectId, regionId, kawaii)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createProjectRegionKawaii: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let kawaii = ; // Kawaii

    let mut context = RegionApi::Context::default();
    let result = client.createProjectRegionKawaii(projectId, regionId, kawaii, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
kawaii *

Kawaii payload.

Responses


createProjectRegionKonvey

Creates a new Konvey (Kowabunga Network Load-Balancer).


/project/{projectId}/region/{regionId}/konvey

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/konvey" \
 -d '{
  "endpoints" : [ {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  }, {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  } ],
  "failover" : true,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vip" : "vip"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createProjectRegionKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Konvey konvey = new Konvey(); // Konvey | 

try {
    final result = await api_instance.createProjectRegionKonvey(projectId, regionId, konvey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKonvey: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createProjectRegionKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Konvey *konvey = ; // 

[apiInstance createProjectRegionKonveyWith:projectId
    regionId:regionId
    konvey:konvey
              completionHandler: ^(Konvey output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var konvey = ; // {Konvey} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKonvey(projectId, regionId, konvey, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var konvey = new Konvey(); // Konvey | 

            try {
                Konvey result = apiInstance.createProjectRegionKonvey(projectId, regionId, konvey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createProjectRegionKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$konvey = ; // Konvey | 

try {
    $result = $api_instance->createProjectRegionKonvey($projectId, $regionId, $konvey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createProjectRegionKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $konvey = WWW::OPenAPIClient::Object::Konvey->new(); # Konvey | 

eval {
    my $result = $api_instance->createProjectRegionKonvey(projectId => $projectId, regionId => $regionId, konvey => $konvey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createProjectRegionKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
konvey =  # Konvey | 

try:
    api_response = api_instance.create_project_region_konvey(projectId, regionId, konvey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createProjectRegionKonvey: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let konvey = ; // Konvey

    let mut context = RegionApi::Context::default();
    let result = client.createProjectRegionKonvey(projectId, regionId, konvey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
konvey *

Konvey payload.

Responses


createProjectRegionKylo

Creates a new Kylo.


/project/{projectId}/region/{regionId}/kylo

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kylo?nfsId=nfsId_example" \
 -d '{
  "endpoint" : "endpoint",
  "access" : "RW",
  "size" : 6,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "protocols" : [ 0, 0 ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kylo kylo = ; // Kylo | 
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createProjectRegionKylo");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Kylo kylo = new Kylo(); // Kylo | 
final String nfsId = new String(); // String | NFS storage ID (optional, region's default if unspecified).

try {
    final result = await api_instance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionKylo: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Kylo kylo = ; // Kylo | 
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createProjectRegionKylo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Kylo *kylo = ; // 
String *nfsId = nfsId_example; // NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance createProjectRegionKyloWith:projectId
    regionId:regionId
    kylo:kylo
    nfsId:nfsId
              completionHandler: ^(Kylo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var kylo = ; // {Kylo} 
var opts = {
  'nfsId': nfsId_example // {String} NFS storage ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionKylo(projectId, regionId, kylo, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionKyloExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var kylo = new Kylo(); // Kylo | 
            var nfsId = nfsId_example;  // String | NFS storage ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                Kylo result = apiInstance.createProjectRegionKylo(projectId, regionId, kylo, nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createProjectRegionKylo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$kylo = ; // Kylo | 
$nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

try {
    $result = $api_instance->createProjectRegionKylo($projectId, $regionId, $kylo, $nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createProjectRegionKylo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $kylo = WWW::OPenAPIClient::Object::Kylo->new(); # Kylo | 
my $nfsId = nfsId_example; # String | NFS storage ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->createProjectRegionKylo(projectId => $projectId, regionId => $regionId, kylo => $kylo, nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createProjectRegionKylo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
kylo =  # Kylo | 
nfsId = nfsId_example # String | NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.create_project_region_kylo(projectId, regionId, kylo, nfsId=nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createProjectRegionKylo: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let kylo = ; // Kylo
    let nfsId = nfsId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.createProjectRegionKylo(projectId, regionId, kylo, nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
kylo *

Kylo payload.

Query parameters
Name Description
nfsId
String
NFS storage ID (optional, region's default if unspecified).

Responses


createProjectRegionVolume

Creates a new storage volume.


/project/{projectId}/region/{regionId}/volume

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/volume?poolId=poolId_example&templateId=templateId_example" \
 -d '{
  "size" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "type" : "os"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Volume volume = ; // Volume | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

        try {
            Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createProjectRegionVolume");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Volume volume = new Volume(); // Volume | 
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).
final String templateId = new String(); // String | Template to clone the storage volume from (optional, region's default if unspecified).

try {
    final result = await api_instance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionVolume: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Volume volume = ; // Volume | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

        try {
            Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createProjectRegionVolume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Volume *volume = ; // 
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
String *templateId = templateId_example; // Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)

[apiInstance createProjectRegionVolumeWith:projectId
    regionId:regionId
    volume:volume
    poolId:poolId
    templateId:templateId
              completionHandler: ^(Volume output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var volume = ; // {Volume} 
var opts = {
  'poolId': poolId_example, // {String} Storage pool ID (optional, region's default if unspecified).
  'templateId': templateId_example // {String} Template to clone the storage volume from (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionVolume(projectId, regionId, volume, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionVolumeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var volume = new Volume(); // Volume | 
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)
            var templateId = templateId_example;  // String | Template to clone the storage volume from (optional, region's default if unspecified). (optional)  (default to null)

            try {
                Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createProjectRegionVolume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$volume = ; // Volume | 
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
$templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

try {
    $result = $api_instance->createProjectRegionVolume($projectId, $regionId, $volume, $poolId, $templateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createProjectRegionVolume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $volume = WWW::OPenAPIClient::Object::Volume->new(); # Volume | 
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).
my $templateId = templateId_example; # String | Template to clone the storage volume from (optional, region's default if unspecified).

eval {
    my $result = $api_instance->createProjectRegionVolume(projectId => $projectId, regionId => $regionId, volume => $volume, poolId => $poolId, templateId => $templateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createProjectRegionVolume: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
volume =  # Volume | 
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
templateId = templateId_example # String | Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.create_project_region_volume(projectId, regionId, volume, poolId=poolId, templateId=templateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createProjectRegionVolume: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let volume = ; // Volume
    let poolId = poolId_example; // String
    let templateId = templateId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
volume *

Volume payload.

Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).
templateId
String
Template to clone the storage volume from (optional, region's default if unspecified).

Responses


createRegion

Creates a new region.


/region

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        Region region = ; // Region | 

        try {
            Region result = apiInstance.createRegion(region);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Region region = new Region(); // Region | 

try {
    final result = await api_instance.createRegion(region);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createRegion: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        Region region = ; // Region | 

        try {
            Region result = apiInstance.createRegion(region);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
Region *region = ; // 

[apiInstance createRegionWith:region
              completionHandler: ^(Region output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var region = ; // {Region} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRegion(region, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createRegionExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var region = new Region(); // Region | 

            try {
                Region result = apiInstance.createRegion(region);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$region = ; // Region | 

try {
    $result = $api_instance->createRegion($region);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $region = WWW::OPenAPIClient::Object::Region->new(); # Region | 

eval {
    my $result = $api_instance->createRegion(region => $region);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
region =  # Region | 

try:
    api_response = api_instance.create_region(region)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createRegion: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let region = ; // Region

    let mut context = RegionApi::Context::default();
    let result = client.createRegion(region, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
region *

Region payload.

Responses


createStorageNFS

Creates a new NFS storage.


/region/{regionId}/nfs

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/nfs?poolId=poolId_example" \
 -d '{
  "endpoint" : "endpoint",
  "port" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "fs" : "nfs",
  "backends" : [ "backends", "backends" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        StorageNFS storageNFS = ; // StorageNFS | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

        try {
            StorageNFS result = apiInstance.createStorageNFS(regionId, storageNFS, poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createStorageNFS");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final StorageNFS storageNFS = new StorageNFS(); // StorageNFS | 
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).

try {
    final result = await api_instance.createStorageNFS(regionId, storageNFS, poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createStorageNFS: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        StorageNFS storageNFS = ; // StorageNFS | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

        try {
            StorageNFS result = apiInstance.createStorageNFS(regionId, storageNFS, poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createStorageNFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
StorageNFS *storageNFS = ; // 
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance createStorageNFSWith:regionId
    storageNFS:storageNFS
    poolId:poolId
              completionHandler: ^(StorageNFS output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var storageNFS = ; // {StorageNFS} 
var opts = {
  'poolId': poolId_example // {String} Storage pool ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createStorageNFS(regionId, storageNFS, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createStorageNFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var storageNFS = new StorageNFS(); // StorageNFS | 
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                StorageNFS result = apiInstance.createStorageNFS(regionId, storageNFS, poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createStorageNFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$storageNFS = ; // StorageNFS | 
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

try {
    $result = $api_instance->createStorageNFS($regionId, $storageNFS, $poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createStorageNFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $storageNFS = WWW::OPenAPIClient::Object::StorageNFS->new(); # StorageNFS | 
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->createStorageNFS(regionId => $regionId, storageNFS => $storageNFS, poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createStorageNFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
storageNFS =  # StorageNFS | 
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.create_storage_nfs(regionId, storageNFS, poolId=poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createStorageNFS: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let storageNFS = ; // StorageNFS
    let poolId = poolId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.createStorageNFS(regionId, storageNFS, poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
storageNFS *

StorageNFS payload.

Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).

Responses


createStoragePool

Creates a new storage pool.


/region/{regionId}/pool

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/pool" \
 -d '{
  "ceph_secret_uuid" : "ceph_secret_uuid",
  "cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "name" : "name",
  "pool" : "pool",
  "ceph_port" : 0,
  "description" : "description",
  "id" : "id",
  "ceph_address" : "localhost",
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        StoragePool storagePool = ; // StoragePool | 

        try {
            StoragePool result = apiInstance.createStoragePool(regionId, storagePool);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createStoragePool");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final StoragePool storagePool = new StoragePool(); // StoragePool | 

try {
    final result = await api_instance.createStoragePool(regionId, storagePool);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createStoragePool: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        StoragePool storagePool = ; // StoragePool | 

        try {
            StoragePool result = apiInstance.createStoragePool(regionId, storagePool);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createStoragePool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
StoragePool *storagePool = ; // 

[apiInstance createStoragePoolWith:regionId
    storagePool:storagePool
              completionHandler: ^(StoragePool output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var storagePool = ; // {StoragePool} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createStoragePool(regionId, storagePool, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createStoragePoolExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var storagePool = new StoragePool(); // StoragePool | 

            try {
                StoragePool result = apiInstance.createStoragePool(regionId, storagePool);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createStoragePool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$storagePool = ; // StoragePool | 

try {
    $result = $api_instance->createStoragePool($regionId, $storagePool);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createStoragePool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $storagePool = WWW::OPenAPIClient::Object::StoragePool->new(); # StoragePool | 

eval {
    my $result = $api_instance->createStoragePool(regionId => $regionId, storagePool => $storagePool);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createStoragePool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
storagePool =  # StoragePool | 

try:
    api_response = api_instance.create_storage_pool(regionId, storagePool)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createStoragePool: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let storagePool = ; // StoragePool

    let mut context = RegionApi::Context::default();
    let result = client.createStoragePool(regionId, storagePool, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
storagePool *

StoragePool payload.

Responses


createVNet

Creates a new virtual network.


/region/{regionId}/vnet

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/vnet" \
 -d '{
  "private" : true,
  "vlan" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "interface" : "interface"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        VNet vNet = ; // VNet | 

        try {
            VNet result = apiInstance.createVNet(regionId, vNet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createVNet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final VNet vNet = new VNet(); // VNet | 

try {
    final result = await api_instance.createVNet(regionId, vNet);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createVNet: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        VNet vNet = ; // VNet | 

        try {
            VNet result = apiInstance.createVNet(regionId, vNet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createVNet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
VNet *vNet = ; // 

[apiInstance createVNetWith:regionId
    vNet:vNet
              completionHandler: ^(VNet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var vNet = ; // {VNet} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createVNet(regionId, vNet, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createVNetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var vNet = new VNet(); // VNet | 

            try {
                VNet result = apiInstance.createVNet(regionId, vNet);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createVNet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$vNet = ; // VNet | 

try {
    $result = $api_instance->createVNet($regionId, $vNet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createVNet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $vNet = WWW::OPenAPIClient::Object::VNet->new(); # VNet | 

eval {
    my $result = $api_instance->createVNet(regionId => $regionId, vNet => $vNet);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createVNet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
vNet =  # VNet | 

try:
    api_response = api_instance.create_v_net(regionId, vNet)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createVNet: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let vNet = ; // VNet

    let mut context = RegionApi::Context::default();
    let result = client.createVNet(regionId, vNet, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
vNet *

VNet payload.

Responses


createZone

Creates a new availability zone.


/region/{regionId}/zone

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/zone" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        Zone zone = ; // Zone | 

        try {
            Zone result = apiInstance.createZone(regionId, zone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createZone");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final Zone zone = new Zone(); // Zone | 

try {
    final result = await api_instance.createZone(regionId, zone);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createZone: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        Zone zone = ; // Zone | 

        try {
            Zone result = apiInstance.createZone(regionId, zone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#createZone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
Zone *zone = ; // 

[apiInstance createZoneWith:regionId
    zone:zone
              completionHandler: ^(Zone output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var zone = ; // {Zone} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createZone(regionId, zone, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createZoneExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var zone = new Zone(); // Zone | 

            try {
                Zone result = apiInstance.createZone(regionId, zone);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.createZone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$zone = ; // Zone | 

try {
    $result = $api_instance->createZone($regionId, $zone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->createZone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $zone = WWW::OPenAPIClient::Object::Zone->new(); # Zone | 

eval {
    my $result = $api_instance->createZone(regionId => $regionId, zone => $zone);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->createZone: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
zone =  # Zone | 

try:
    api_response = api_instance.create_zone(regionId, zone)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->createZone: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let zone = ; // Zone

    let mut context = RegionApi::Context::default();
    let result = client.createZone(regionId, zone, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
zone *

Zone payload.

Responses


deleteRegion

Deletes an existing region.


/region/{regionId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            apiInstance.deleteRegion(regionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#deleteRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.deleteRegion(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteRegion: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            apiInstance.deleteRegion(regionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#deleteRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance deleteRegionWith:regionId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRegion(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteRegionExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                apiInstance.deleteRegion(regionId);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.deleteRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $api_instance->deleteRegion($regionId);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->deleteRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    $api_instance->deleteRegion(regionId => $regionId);
};
if ($@) {
    warn "Exception when calling RegionApi->deleteRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_instance.delete_region(regionId)
except ApiException as e:
    print("Exception when calling RegionApi->deleteRegion: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.deleteRegion(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


listProjectRegionKawaiis

Returns the IDs of Kawaii objects.


/project/{projectId}/region/{regionId}/kawaiis

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kawaiis"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listProjectRegionKawaiis");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionKawaiis(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKawaiis: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listProjectRegionKawaiis");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionKawaiisWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKawaiis(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKawaiisExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKawaiis(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listProjectRegionKawaiis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionKawaiis($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listProjectRegionKawaiis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionKawaiis(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listProjectRegionKawaiis: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_kawaiis(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listProjectRegionKawaiis: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listProjectRegionKawaiis(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


listProjectRegionKonveys

Returns the IDs of Konvey (Kowabunga Network Load-Balancer) objects.


/project/{projectId}/region/{regionId}/konveys

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/konveys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listProjectRegionKonveys");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionKonveys(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKonveys: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listProjectRegionKonveys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionKonveysWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKonveys(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKonveysExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKonveys(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listProjectRegionKonveys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionKonveys($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listProjectRegionKonveys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionKonveys(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listProjectRegionKonveys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_konveys(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listProjectRegionKonveys: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listProjectRegionKonveys(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


listProjectRegionKylos

Returns the IDs of Kylo objects.


/project/{projectId}/region/{regionId}/kylo

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/kylo?nfsId=nfsId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listProjectRegionKylos");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final String nfsId = new String(); // String | NFS storage ID (optional, region's default if unspecified).

try {
    final result = await api_instance.listProjectRegionKylos(projectId, regionId, nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionKylos: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listProjectRegionKylos");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
String *nfsId = nfsId_example; // NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance listProjectRegionKylosWith:projectId
    regionId:regionId
    nfsId:nfsId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var opts = {
  'nfsId': nfsId_example // {String} NFS storage ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionKylos(projectId, regionId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionKylosExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var nfsId = nfsId_example;  // String | NFS storage ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionKylos(projectId, regionId, nfsId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listProjectRegionKylos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$nfsId = nfsId_example; // String | NFS storage ID (optional, region's default if unspecified).

try {
    $result = $api_instance->listProjectRegionKylos($projectId, $regionId, $nfsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listProjectRegionKylos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $nfsId = nfsId_example; # String | NFS storage ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->listProjectRegionKylos(projectId => $projectId, regionId => $regionId, nfsId => $nfsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listProjectRegionKylos: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
nfsId = nfsId_example # String | NFS storage ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.list_project_region_kylos(projectId, regionId, nfsId=nfsId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listProjectRegionKylos: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let nfsId = nfsId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listProjectRegionKylos(projectId, regionId, nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Query parameters
Name Description
nfsId
String
NFS storage ID (optional, region's default if unspecified).

Responses


listProjectRegionVolumes

Returns the IDs of storage volume objects.


/project/{projectId}/region/{regionId}/volumes

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/volumes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listProjectRegionVolumes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionVolumes(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionVolumes: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listProjectRegionVolumes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionVolumesWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionVolumes(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionVolumesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listProjectRegionVolumes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionVolumes($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listProjectRegionVolumes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionVolumes(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listProjectRegionVolumes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_volumes(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listProjectRegionVolumes: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listProjectRegionVolumes(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


listRegionKiwis

Returns the IDs of Kiwi (Kowabunga Inner Wan Interface) provides edge-network services. objects.


/region/{regionId}/kiwis

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/kiwis"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionKiwis(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionKiwis");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listRegionKiwis(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionKiwis: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionKiwis(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionKiwis");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listRegionKiwisWith:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionKiwis(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionKiwisExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listRegionKiwis(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listRegionKiwis: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listRegionKiwis($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listRegionKiwis: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listRegionKiwis(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listRegionKiwis: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_region_kiwis(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listRegionKiwis: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listRegionKiwis(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


listRegionStorageNFSs

Returns the IDs of NFS storage objects.


/region/{regionId}/nfs

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/nfs?poolId=poolId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listRegionStorageNFSs(regionId, poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionStorageNFSs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).

try {
    final result = await api_instance.listRegionStorageNFSs(regionId, poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionStorageNFSs: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

        try {
            array['String'] result = apiInstance.listRegionStorageNFSs(regionId, poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionStorageNFSs");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)

[apiInstance listRegionStorageNFSsWith:regionId
    poolId:poolId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var opts = {
  'poolId': poolId_example // {String} Storage pool ID (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionStorageNFSs(regionId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionStorageNFSsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)

            try {
                array['String'] result = apiInstance.listRegionStorageNFSs(regionId, poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listRegionStorageNFSs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).

try {
    $result = $api_instance->listRegionStorageNFSs($regionId, $poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listRegionStorageNFSs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).

eval {
    my $result = $api_instance->listRegionStorageNFSs(regionId => $regionId, poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listRegionStorageNFSs: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.list_region_storage_nfss(regionId, poolId=poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listRegionStorageNFSs: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let poolId = poolId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listRegionStorageNFSs(regionId, poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).

Responses


listRegionStoragePools

Returns the IDs of storage pool objects.


/region/{regionId}/pools

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/pools"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionStoragePools(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionStoragePools");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listRegionStoragePools(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionStoragePools: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionStoragePools(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionStoragePools");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listRegionStoragePoolsWith:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionStoragePools(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionStoragePoolsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listRegionStoragePools(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listRegionStoragePools: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listRegionStoragePools($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listRegionStoragePools: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listRegionStoragePools(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listRegionStoragePools: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_region_storage_pools(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listRegionStoragePools: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listRegionStoragePools(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


listRegionVNets

Returns the IDs of virtual network objects.


/region/{regionId}/vnets

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/vnets"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionVNets(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionVNets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listRegionVNets(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionVNets: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionVNets(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionVNets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listRegionVNetsWith:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionVNets(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionVNetsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listRegionVNets(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listRegionVNets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listRegionVNets($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listRegionVNets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listRegionVNets(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listRegionVNets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_region_v_nets(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listRegionVNets: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listRegionVNets(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


listRegionZones

Returns the IDs of availability zone objects.


/region/{regionId}/zones

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/zones"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionZones(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionZones");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listRegionZones(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionZones: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionZones(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegionZones");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listRegionZonesWith:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionZones(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionZonesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listRegionZones(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listRegionZones: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listRegionZones($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listRegionZones: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listRegionZones(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listRegionZones: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_region_zones(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listRegionZones: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.listRegionZones(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


listRegions

Returns the IDs of region objects.


/region

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();

        try {
            array['String'] result = apiInstance.listRegions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listRegions();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegions: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();

        try {
            array['String'] result = apiInstance.listRegions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#listRegions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];

[apiInstance listRegionsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegions(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();

            try {
                array['String'] result = apiInstance.listRegions();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.listRegions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();

try {
    $result = $api_instance->listRegions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->listRegions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();

eval {
    my $result = $api_instance->listRegions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->listRegions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()

try:
    api_response = api_instance.list_regions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->listRegions: %s\n" % e)
extern crate RegionApi;

pub fn main() {

    let mut context = RegionApi::Context::default();
    let result = client.listRegions(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readRegion

Returns a region.


/region/{regionId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            Region result = apiInstance.readRegion(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#readRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.readRegion(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readRegion: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            Region result = apiInstance.readRegion(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#readRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance readRegionWith:regionId
              completionHandler: ^(Region output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readRegion(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readRegionExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                Region result = apiInstance.readRegion(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.readRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->readRegion($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->readRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->readRegion(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->readRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.read_region(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->readRegion: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.readRegion(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


setRegionDefaultStorageNFS

Performs a region setting of default NFS storage.


/region/{regionId}/nfs/{nfsId}/default

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/nfs/{nfsId}/default"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            apiInstance.setRegionDefaultStorageNFS(regionId, nfsId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#setRegionDefaultStorageNFS");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final String nfsId = new String(); // String | The ID of the NFS storage.

try {
    final result = await api_instance.setRegionDefaultStorageNFS(regionId, nfsId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setRegionDefaultStorageNFS: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        String nfsId = nfsId_example; // String | The ID of the NFS storage.

        try {
            apiInstance.setRegionDefaultStorageNFS(regionId, nfsId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#setRegionDefaultStorageNFS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
String *nfsId = nfsId_example; // The ID of the NFS storage. (default to null)

[apiInstance setRegionDefaultStorageNFSWith:regionId
    nfsId:nfsId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var nfsId = nfsId_example; // {String} The ID of the NFS storage.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setRegionDefaultStorageNFS(regionId, nfsId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setRegionDefaultStorageNFSExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var nfsId = nfsId_example;  // String | The ID of the NFS storage. (default to null)

            try {
                apiInstance.setRegionDefaultStorageNFS(regionId, nfsId);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.setRegionDefaultStorageNFS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$nfsId = nfsId_example; // String | The ID of the NFS storage.

try {
    $api_instance->setRegionDefaultStorageNFS($regionId, $nfsId);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->setRegionDefaultStorageNFS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $nfsId = nfsId_example; # String | The ID of the NFS storage.

eval {
    $api_instance->setRegionDefaultStorageNFS(regionId => $regionId, nfsId => $nfsId);
};
if ($@) {
    warn "Exception when calling RegionApi->setRegionDefaultStorageNFS: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
nfsId = nfsId_example # String | The ID of the NFS storage. (default to null)

try:
    api_instance.set_region_default_storage_nfs(regionId, nfsId)
except ApiException as e:
    print("Exception when calling RegionApi->setRegionDefaultStorageNFS: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let nfsId = nfsId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.setRegionDefaultStorageNFS(regionId, nfsId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
nfsId*
String
The ID of the NFS storage.
Required

Responses


setRegionDefaultStoragePool

Performs a region setting of default storage pool.


/region/{regionId}/pool/{poolId}/default

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/pool/{poolId}/default"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            apiInstance.setRegionDefaultStoragePool(regionId, poolId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#setRegionDefaultStoragePool");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final String poolId = new String(); // String | The ID of the storage pool.

try {
    final result = await api_instance.setRegionDefaultStoragePool(regionId, poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setRegionDefaultStoragePool: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            apiInstance.setRegionDefaultStoragePool(regionId, poolId);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#setRegionDefaultStoragePool");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
String *poolId = poolId_example; // The ID of the storage pool. (default to null)

[apiInstance setRegionDefaultStoragePoolWith:regionId
    poolId:poolId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var poolId = poolId_example; // {String} The ID of the storage pool.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setRegionDefaultStoragePool(regionId, poolId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setRegionDefaultStoragePoolExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)

            try {
                apiInstance.setRegionDefaultStoragePool(regionId, poolId);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.setRegionDefaultStoragePool: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$poolId = poolId_example; // String | The ID of the storage pool.

try {
    $api_instance->setRegionDefaultStoragePool($regionId, $poolId);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->setRegionDefaultStoragePool: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $poolId = poolId_example; # String | The ID of the storage pool.

eval {
    $api_instance->setRegionDefaultStoragePool(regionId => $regionId, poolId => $poolId);
};
if ($@) {
    warn "Exception when calling RegionApi->setRegionDefaultStoragePool: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
poolId = poolId_example # String | The ID of the storage pool. (default to null)

try:
    api_instance.set_region_default_storage_pool(regionId, poolId)
except ApiException as e:
    print("Exception when calling RegionApi->setRegionDefaultStoragePool: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let poolId = poolId_example; // String

    let mut context = RegionApi::Context::default();
    let result = client.setRegionDefaultStoragePool(regionId, poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
poolId*
String
The ID of the storage pool.
Required

Responses


updateRegion

Updates a region configuration.


/region/{regionId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RegionApi;

import java.io.File;
import java.util.*;

public class RegionApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        Region region = ; // Region | 

        try {
            Region result = apiInstance.updateRegion(regionId, region);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#updateRegion");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final Region region = new Region(); // Region | 

try {
    final result = await api_instance.updateRegion(regionId, region);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateRegion: $e\n');
}

import org.openapitools.client.api.RegionApi;

public class RegionApiExample {
    public static void main(String[] args) {
        RegionApi apiInstance = new RegionApi();
        String regionId = regionId_example; // String | The ID of the region.
        Region region = ; // Region | 

        try {
            Region result = apiInstance.updateRegion(regionId, region);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegionApi#updateRegion");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
RegionApi *apiInstance = [[RegionApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
Region *region = ; // 

[apiInstance updateRegionWith:regionId
    region:region
              completionHandler: ^(Region output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.RegionApi()
var regionId = regionId_example; // {String} The ID of the region.
var region = ; // {Region} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRegion(regionId, region, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateRegionExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new RegionApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var region = new Region(); // Region | 

            try {
                Region result = apiInstance.updateRegion(regionId, region);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RegionApi.updateRegion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RegionApi();
$regionId = regionId_example; // String | The ID of the region.
$region = ; // Region | 

try {
    $result = $api_instance->updateRegion($regionId, $region);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegionApi->updateRegion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RegionApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RegionApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $region = WWW::OPenAPIClient::Object::Region->new(); # Region | 

eval {
    my $result = $api_instance->updateRegion(regionId => $regionId, region => $region);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegionApi->updateRegion: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.RegionApi()
regionId = regionId_example # String | The ID of the region. (default to null)
region =  # Region | 

try:
    api_response = api_instance.update_region(regionId, region)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegionApi->updateRegion: %s\n" % e)
extern crate RegionApi;

pub fn main() {
    let regionId = regionId_example; // String
    let region = ; // Region

    let mut context = RegionApi::Context::default();
    let result = client.updateRegion(regionId, region, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
region *

Region payload.

Responses


Subnet

createAdapter

Creates a new network adapter.


/subnet/{subnetId}/adapter

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/subnet/{subnetId}/adapter?assignIP=true" \
 -d '{
  "addresses" : [ "addresses", "addresses" ],
  "reserved" : false,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "mac" : "mac"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.
        Adapter adapter = ; // Adapter | 
        Boolean assignIP = true; // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

        try {
            Adapter result = apiInstance.createAdapter(subnetId, adapter, assignIP);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#createAdapter");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String subnetId = new String(); // String | The ID of the network subnet.
final Adapter adapter = new Adapter(); // Adapter | 
final Boolean assignIP = new Boolean(); // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

try {
    final result = await api_instance.createAdapter(subnetId, adapter, assignIP);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createAdapter: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.
        Adapter adapter = ; // Adapter | 
        Boolean assignIP = true; // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

        try {
            Adapter result = apiInstance.createAdapter(subnetId, adapter, assignIP);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#createAdapter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)
Adapter *adapter = ; // 
Boolean *assignIP = true; // Whether Kowabunga should pick and assign an IP address to this adapter. (optional) (default to null)

[apiInstance createAdapterWith:subnetId
    adapter:adapter
    assignIP:assignIP
              completionHandler: ^(Adapter output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var subnetId = subnetId_example; // {String} The ID of the network subnet.
var adapter = ; // {Adapter} 
var opts = {
  'assignIP': true // {Boolean} Whether Kowabunga should pick and assign an IP address to this adapter.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAdapter(subnetId, adapter, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createAdapterExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)
            var adapter = new Adapter(); // Adapter | 
            var assignIP = true;  // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter. (optional)  (default to null)

            try {
                Adapter result = apiInstance.createAdapter(subnetId, adapter, assignIP);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.createAdapter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();
$subnetId = subnetId_example; // String | The ID of the network subnet.
$adapter = ; // Adapter | 
$assignIP = true; // Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

try {
    $result = $api_instance->createAdapter($subnetId, $adapter, $assignIP);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->createAdapter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();
my $subnetId = subnetId_example; # String | The ID of the network subnet.
my $adapter = WWW::OPenAPIClient::Object::Adapter->new(); # Adapter | 
my $assignIP = true; # Boolean | Whether Kowabunga should pick and assign an IP address to this adapter.

eval {
    my $result = $api_instance->createAdapter(subnetId => $subnetId, adapter => $adapter, assignIP => $assignIP);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubnetApi->createAdapter: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)
adapter =  # Adapter | 
assignIP = true # Boolean | Whether Kowabunga should pick and assign an IP address to this adapter. (optional) (default to null)

try:
    api_response = api_instance.create_adapter(subnetId, adapter, assignIP=assignIP)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubnetApi->createAdapter: %s\n" % e)
extern crate SubnetApi;

pub fn main() {
    let subnetId = subnetId_example; // String
    let adapter = ; // Adapter
    let assignIP = true; // Boolean

    let mut context = SubnetApi::Context::default();
    let result = client.createAdapter(subnetId, adapter, assignIP, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
subnetId*
String
The ID of the network subnet.
Required
Body parameters
Name Description
adapter *

Adapter payload.

Query parameters
Name Description
assignIP
Boolean
Whether Kowabunga should pick and assign an IP address to this adapter.

Responses


createSubnet

Creates a new network subnet.


/vnet/{vnetId}/subnet

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/vnet/{vnetId}/subnet" \
 -d '{
  "extra_routes" : [ "extra_routes", "extra_routes" ],
  "application" : "user",
  "reserved" : [ {
    "last" : "last",
    "first" : "first"
  }, {
    "last" : "last",
    "first" : "first"
  } ],
  "name" : "name",
  "dns" : "dns",
  "description" : "description",
  "cidr" : "cidr",
  "gw_pool" : [ {
    "last" : "last",
    "first" : "first"
  }, {
    "last" : "last",
    "first" : "first"
  } ],
  "id" : "id",
  "gateway" : "gateway"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        Subnet subnet = ; // Subnet | 

        try {
            Subnet result = apiInstance.createSubnet(vnetId, subnet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#createSubnet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.
final Subnet subnet = new Subnet(); // Subnet | 

try {
    final result = await api_instance.createSubnet(vnetId, subnet);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createSubnet: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        Subnet subnet = ; // Subnet | 

        try {
            Subnet result = apiInstance.createSubnet(vnetId, subnet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#createSubnet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)
Subnet *subnet = ; // 

[apiInstance createSubnetWith:vnetId
    subnet:subnet
              completionHandler: ^(Subnet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.
var subnet = ; // {Subnet} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSubnet(vnetId, subnet, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createSubnetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)
            var subnet = new Subnet(); // Subnet | 

            try {
                Subnet result = apiInstance.createSubnet(vnetId, subnet);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.createSubnet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.
$subnet = ; // Subnet | 

try {
    $result = $api_instance->createSubnet($vnetId, $subnet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->createSubnet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.
my $subnet = WWW::OPenAPIClient::Object::Subnet->new(); # Subnet | 

eval {
    my $result = $api_instance->createSubnet(vnetId => $vnetId, subnet => $subnet);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubnetApi->createSubnet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)
subnet =  # Subnet | 

try:
    api_response = api_instance.create_subnet(vnetId, subnet)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubnetApi->createSubnet: %s\n" % e)
extern crate SubnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String
    let subnet = ; // Subnet

    let mut context = SubnetApi::Context::default();
    let result = client.createSubnet(vnetId, subnet, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required
Body parameters
Name Description
subnet *

Subnet payload.

Responses


deleteSubnet

Deletes an existing network subnet.


/subnet/{subnetId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/subnet/{subnetId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            apiInstance.deleteSubnet(subnetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#deleteSubnet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String subnetId = new String(); // String | The ID of the network subnet.

try {
    final result = await api_instance.deleteSubnet(subnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSubnet: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            apiInstance.deleteSubnet(subnetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#deleteSubnet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)

[apiInstance deleteSubnetWith:subnetId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var subnetId = subnetId_example; // {String} The ID of the network subnet.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteSubnet(subnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteSubnetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)

            try {
                apiInstance.deleteSubnet(subnetId);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.deleteSubnet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();
$subnetId = subnetId_example; // String | The ID of the network subnet.

try {
    $api_instance->deleteSubnet($subnetId);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->deleteSubnet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();
my $subnetId = subnetId_example; # String | The ID of the network subnet.

eval {
    $api_instance->deleteSubnet(subnetId => $subnetId);
};
if ($@) {
    warn "Exception when calling SubnetApi->deleteSubnet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)

try:
    api_instance.delete_subnet(subnetId)
except ApiException as e:
    print("Exception when calling SubnetApi->deleteSubnet: %s\n" % e)
extern crate SubnetApi;

pub fn main() {
    let subnetId = subnetId_example; // String

    let mut context = SubnetApi::Context::default();
    let result = client.deleteSubnet(subnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
subnetId*
String
The ID of the network subnet.
Required

Responses


listSubnetAdapters

Returns the IDs of network adapter objects.


/subnet/{subnetId}/adapters

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/subnet/{subnetId}/adapters"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            array['String'] result = apiInstance.listSubnetAdapters(subnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#listSubnetAdapters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String subnetId = new String(); // String | The ID of the network subnet.

try {
    final result = await api_instance.listSubnetAdapters(subnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listSubnetAdapters: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            array['String'] result = apiInstance.listSubnetAdapters(subnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#listSubnetAdapters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)

[apiInstance listSubnetAdaptersWith:subnetId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var subnetId = subnetId_example; // {String} The ID of the network subnet.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubnetAdapters(subnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listSubnetAdaptersExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)

            try {
                array['String'] result = apiInstance.listSubnetAdapters(subnetId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.listSubnetAdapters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();
$subnetId = subnetId_example; // String | The ID of the network subnet.

try {
    $result = $api_instance->listSubnetAdapters($subnetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->listSubnetAdapters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();
my $subnetId = subnetId_example; # String | The ID of the network subnet.

eval {
    my $result = $api_instance->listSubnetAdapters(subnetId => $subnetId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubnetApi->listSubnetAdapters: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)

try:
    api_response = api_instance.list_subnet_adapters(subnetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubnetApi->listSubnetAdapters: %s\n" % e)
extern crate SubnetApi;

pub fn main() {
    let subnetId = subnetId_example; // String

    let mut context = SubnetApi::Context::default();
    let result = client.listSubnetAdapters(subnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
subnetId*
String
The ID of the network subnet.
Required

Responses


listSubnets

Returns the IDs of network subnet objects.


/subnet

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/subnet"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();

        try {
            array['String'] result = apiInstance.listSubnets();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#listSubnets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listSubnets();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listSubnets: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();

        try {
            array['String'] result = apiInstance.listSubnets();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#listSubnets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];

[apiInstance listSubnetsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listSubnets(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listSubnetsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();

            try {
                array['String'] result = apiInstance.listSubnets();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.listSubnets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();

try {
    $result = $api_instance->listSubnets();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->listSubnets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();

eval {
    my $result = $api_instance->listSubnets();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubnetApi->listSubnets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()

try:
    api_response = api_instance.list_subnets()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubnetApi->listSubnets: %s\n" % e)
extern crate SubnetApi;

pub fn main() {

    let mut context = SubnetApi::Context::default();
    let result = client.listSubnets(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


listVNetSubnets

Returns the IDs of network subnet objects.


/vnet/{vnetId}/subnets

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/vnet/{vnetId}/subnets"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.

        try {
            array['String'] result = apiInstance.listVNetSubnets(vnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#listVNetSubnets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.

try {
    final result = await api_instance.listVNetSubnets(vnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listVNetSubnets: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.

        try {
            array['String'] result = apiInstance.listVNetSubnets(vnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#listVNetSubnets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)

[apiInstance listVNetSubnetsWith:vnetId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listVNetSubnets(vnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listVNetSubnetsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)

            try {
                array['String'] result = apiInstance.listVNetSubnets(vnetId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.listVNetSubnets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.

try {
    $result = $api_instance->listVNetSubnets($vnetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->listVNetSubnets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.

eval {
    my $result = $api_instance->listVNetSubnets(vnetId => $vnetId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubnetApi->listVNetSubnets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)

try:
    api_response = api_instance.list_v_net_subnets(vnetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubnetApi->listVNetSubnets: %s\n" % e)
extern crate SubnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String

    let mut context = SubnetApi::Context::default();
    let result = client.listVNetSubnets(vnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required

Responses


readSubnet

Returns a network subnet.


/subnet/{subnetId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/subnet/{subnetId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            Subnet result = apiInstance.readSubnet(subnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#readSubnet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String subnetId = new String(); // String | The ID of the network subnet.

try {
    final result = await api_instance.readSubnet(subnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readSubnet: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            Subnet result = apiInstance.readSubnet(subnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#readSubnet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)

[apiInstance readSubnetWith:subnetId
              completionHandler: ^(Subnet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var subnetId = subnetId_example; // {String} The ID of the network subnet.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readSubnet(subnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readSubnetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)

            try {
                Subnet result = apiInstance.readSubnet(subnetId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.readSubnet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();
$subnetId = subnetId_example; // String | The ID of the network subnet.

try {
    $result = $api_instance->readSubnet($subnetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->readSubnet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();
my $subnetId = subnetId_example; # String | The ID of the network subnet.

eval {
    my $result = $api_instance->readSubnet(subnetId => $subnetId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubnetApi->readSubnet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)

try:
    api_response = api_instance.read_subnet(subnetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubnetApi->readSubnet: %s\n" % e)
extern crate SubnetApi;

pub fn main() {
    let subnetId = subnetId_example; // String

    let mut context = SubnetApi::Context::default();
    let result = client.readSubnet(subnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
subnetId*
String
The ID of the network subnet.
Required

Responses


setVNetDefaultSubnet

Performs a virtual network setting of default network subnet.


/vnet/{vnetId}/subnet/{subnetId}/default

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/vnet/{vnetId}/subnet/{subnetId}/default"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            apiInstance.setVNetDefaultSubnet(vnetId, subnetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#setVNetDefaultSubnet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.
final String subnetId = new String(); // String | The ID of the network subnet.

try {
    final result = await api_instance.setVNetDefaultSubnet(vnetId, subnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setVNetDefaultSubnet: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            apiInstance.setVNetDefaultSubnet(vnetId, subnetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#setVNetDefaultSubnet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)

[apiInstance setVNetDefaultSubnetWith:vnetId
    subnetId:subnetId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.
var subnetId = subnetId_example; // {String} The ID of the network subnet.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setVNetDefaultSubnet(vnetId, subnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setVNetDefaultSubnetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)

            try {
                apiInstance.setVNetDefaultSubnet(vnetId, subnetId);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.setVNetDefaultSubnet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.
$subnetId = subnetId_example; // String | The ID of the network subnet.

try {
    $api_instance->setVNetDefaultSubnet($vnetId, $subnetId);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->setVNetDefaultSubnet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.
my $subnetId = subnetId_example; # String | The ID of the network subnet.

eval {
    $api_instance->setVNetDefaultSubnet(vnetId => $vnetId, subnetId => $subnetId);
};
if ($@) {
    warn "Exception when calling SubnetApi->setVNetDefaultSubnet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)

try:
    api_instance.set_v_net_default_subnet(vnetId, subnetId)
except ApiException as e:
    print("Exception when calling SubnetApi->setVNetDefaultSubnet: %s\n" % e)
extern crate SubnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String
    let subnetId = subnetId_example; // String

    let mut context = SubnetApi::Context::default();
    let result = client.setVNetDefaultSubnet(vnetId, subnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required
subnetId*
String
The ID of the network subnet.
Required

Responses


updateSubnet

Updates a network subnet configuration.


/subnet/{subnetId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/subnet/{subnetId}" \
 -d '{
  "extra_routes" : [ "extra_routes", "extra_routes" ],
  "application" : "user",
  "reserved" : [ {
    "last" : "last",
    "first" : "first"
  }, {
    "last" : "last",
    "first" : "first"
  } ],
  "name" : "name",
  "dns" : "dns",
  "description" : "description",
  "cidr" : "cidr",
  "gw_pool" : [ {
    "last" : "last",
    "first" : "first"
  }, {
    "last" : "last",
    "first" : "first"
  } ],
  "id" : "id",
  "gateway" : "gateway"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubnetApi;

import java.io.File;
import java.util.*;

public class SubnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.
        Subnet subnet = ; // Subnet | 

        try {
            Subnet result = apiInstance.updateSubnet(subnetId, subnet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#updateSubnet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String subnetId = new String(); // String | The ID of the network subnet.
final Subnet subnet = new Subnet(); // Subnet | 

try {
    final result = await api_instance.updateSubnet(subnetId, subnet);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateSubnet: $e\n');
}

import org.openapitools.client.api.SubnetApi;

public class SubnetApiExample {
    public static void main(String[] args) {
        SubnetApi apiInstance = new SubnetApi();
        String subnetId = subnetId_example; // String | The ID of the network subnet.
        Subnet subnet = ; // Subnet | 

        try {
            Subnet result = apiInstance.updateSubnet(subnetId, subnet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubnetApi#updateSubnet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
SubnetApi *apiInstance = [[SubnetApi alloc] init];
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)
Subnet *subnet = ; // 

[apiInstance updateSubnetWith:subnetId
    subnet:subnet
              completionHandler: ^(Subnet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.SubnetApi()
var subnetId = subnetId_example; // {String} The ID of the network subnet.
var subnet = ; // {Subnet} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateSubnet(subnetId, subnet, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateSubnetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new SubnetApi();
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)
            var subnet = new Subnet(); // Subnet | 

            try {
                Subnet result = apiInstance.updateSubnet(subnetId, subnet);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubnetApi.updateSubnet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubnetApi();
$subnetId = subnetId_example; // String | The ID of the network subnet.
$subnet = ; // Subnet | 

try {
    $result = $api_instance->updateSubnet($subnetId, $subnet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubnetApi->updateSubnet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubnetApi->new();
my $subnetId = subnetId_example; # String | The ID of the network subnet.
my $subnet = WWW::OPenAPIClient::Object::Subnet->new(); # Subnet | 

eval {
    my $result = $api_instance->updateSubnet(subnetId => $subnetId, subnet => $subnet);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubnetApi->updateSubnet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.SubnetApi()
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)
subnet =  # Subnet | 

try:
    api_response = api_instance.update_subnet(subnetId, subnet)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubnetApi->updateSubnet: %s\n" % e)
extern crate SubnetApi;

pub fn main() {
    let subnetId = subnetId_example; // String
    let subnet = ; // Subnet

    let mut context = SubnetApi::Context::default();
    let result = client.updateSubnet(subnetId, subnet, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
subnetId*
String
The ID of the network subnet.
Required
Body parameters
Name Description
subnet *

Subnet payload.

Responses


Team

createTeam

Creates a new Kowabunga users team.


/team

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/team" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "users" : [ "users", "users" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TeamApi;

import java.io.File;
import java.util.*;

public class TeamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TeamApi apiInstance = new TeamApi();
        Team team = ; // Team | 

        try {
            Team result = apiInstance.createTeam(team);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#createTeam");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Team team = new Team(); // Team | 

try {
    final result = await api_instance.createTeam(team);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTeam: $e\n');
}

import org.openapitools.client.api.TeamApi;

public class TeamApiExample {
    public static void main(String[] args) {
        TeamApi apiInstance = new TeamApi();
        Team team = ; // Team | 

        try {
            Team result = apiInstance.createTeam(team);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#createTeam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TeamApi *apiInstance = [[TeamApi alloc] init];
Team *team = ; // 

[apiInstance createTeamWith:team
              completionHandler: ^(Team output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TeamApi()
var team = ; // {Team} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTeam(team, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createTeamExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TeamApi();
            var team = new Team(); // Team | 

            try {
                Team result = apiInstance.createTeam(team);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TeamApi.createTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TeamApi();
$team = ; // Team | 

try {
    $result = $api_instance->createTeam($team);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->createTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TeamApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TeamApi->new();
my $team = WWW::OPenAPIClient::Object::Team->new(); # Team | 

eval {
    my $result = $api_instance->createTeam(team => $team);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamApi->createTeam: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TeamApi()
team =  # Team | 

try:
    api_response = api_instance.create_team(team)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamApi->createTeam: %s\n" % e)
extern crate TeamApi;

pub fn main() {
    let team = ; // Team

    let mut context = TeamApi::Context::default();
    let result = client.createTeam(team, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
team *

Team payload.

Responses


deleteTeam

Deletes an existing Kowabunga users team.


/team/{teamId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/team/{teamId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TeamApi;

import java.io.File;
import java.util.*;

public class TeamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TeamApi apiInstance = new TeamApi();
        String teamId = teamId_example; // String | The ID of the Kowabunga users team.

        try {
            apiInstance.deleteTeam(teamId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#deleteTeam");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String teamId = new String(); // String | The ID of the Kowabunga users team.

try {
    final result = await api_instance.deleteTeam(teamId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTeam: $e\n');
}

import org.openapitools.client.api.TeamApi;

public class TeamApiExample {
    public static void main(String[] args) {
        TeamApi apiInstance = new TeamApi();
        String teamId = teamId_example; // String | The ID of the Kowabunga users team.

        try {
            apiInstance.deleteTeam(teamId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#deleteTeam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TeamApi *apiInstance = [[TeamApi alloc] init];
String *teamId = teamId_example; // The ID of the Kowabunga users team. (default to null)

[apiInstance deleteTeamWith:teamId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TeamApi()
var teamId = teamId_example; // {String} The ID of the Kowabunga users team.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTeam(teamId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteTeamExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TeamApi();
            var teamId = teamId_example;  // String | The ID of the Kowabunga users team. (default to null)

            try {
                apiInstance.deleteTeam(teamId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TeamApi.deleteTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TeamApi();
$teamId = teamId_example; // String | The ID of the Kowabunga users team.

try {
    $api_instance->deleteTeam($teamId);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->deleteTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TeamApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TeamApi->new();
my $teamId = teamId_example; # String | The ID of the Kowabunga users team.

eval {
    $api_instance->deleteTeam(teamId => $teamId);
};
if ($@) {
    warn "Exception when calling TeamApi->deleteTeam: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TeamApi()
teamId = teamId_example # String | The ID of the Kowabunga users team. (default to null)

try:
    api_instance.delete_team(teamId)
except ApiException as e:
    print("Exception when calling TeamApi->deleteTeam: %s\n" % e)
extern crate TeamApi;

pub fn main() {
    let teamId = teamId_example; // String

    let mut context = TeamApi::Context::default();
    let result = client.deleteTeam(teamId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
teamId*
String
The ID of the Kowabunga users team.
Required

Responses


listTeams

Returns the IDs of Kowabunga users team objects.


/team

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/team"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TeamApi;

import java.io.File;
import java.util.*;

public class TeamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TeamApi apiInstance = new TeamApi();

        try {
            array['String'] result = apiInstance.listTeams();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#listTeams");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listTeams();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listTeams: $e\n');
}

import org.openapitools.client.api.TeamApi;

public class TeamApiExample {
    public static void main(String[] args) {
        TeamApi apiInstance = new TeamApi();

        try {
            array['String'] result = apiInstance.listTeams();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#listTeams");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TeamApi *apiInstance = [[TeamApi alloc] init];

[apiInstance listTeamsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TeamApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listTeams(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listTeamsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TeamApi();

            try {
                array['String'] result = apiInstance.listTeams();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TeamApi.listTeams: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TeamApi();

try {
    $result = $api_instance->listTeams();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->listTeams: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TeamApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TeamApi->new();

eval {
    my $result = $api_instance->listTeams();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamApi->listTeams: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TeamApi()

try:
    api_response = api_instance.list_teams()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamApi->listTeams: %s\n" % e)
extern crate TeamApi;

pub fn main() {

    let mut context = TeamApi::Context::default();
    let result = client.listTeams(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readTeam

Returns a Kowabunga users team.


/team/{teamId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/team/{teamId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TeamApi;

import java.io.File;
import java.util.*;

public class TeamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TeamApi apiInstance = new TeamApi();
        String teamId = teamId_example; // String | The ID of the Kowabunga users team.

        try {
            Team result = apiInstance.readTeam(teamId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#readTeam");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String teamId = new String(); // String | The ID of the Kowabunga users team.

try {
    final result = await api_instance.readTeam(teamId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readTeam: $e\n');
}

import org.openapitools.client.api.TeamApi;

public class TeamApiExample {
    public static void main(String[] args) {
        TeamApi apiInstance = new TeamApi();
        String teamId = teamId_example; // String | The ID of the Kowabunga users team.

        try {
            Team result = apiInstance.readTeam(teamId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#readTeam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TeamApi *apiInstance = [[TeamApi alloc] init];
String *teamId = teamId_example; // The ID of the Kowabunga users team. (default to null)

[apiInstance readTeamWith:teamId
              completionHandler: ^(Team output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TeamApi()
var teamId = teamId_example; // {String} The ID of the Kowabunga users team.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTeam(teamId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readTeamExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TeamApi();
            var teamId = teamId_example;  // String | The ID of the Kowabunga users team. (default to null)

            try {
                Team result = apiInstance.readTeam(teamId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TeamApi.readTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TeamApi();
$teamId = teamId_example; // String | The ID of the Kowabunga users team.

try {
    $result = $api_instance->readTeam($teamId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->readTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TeamApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TeamApi->new();
my $teamId = teamId_example; # String | The ID of the Kowabunga users team.

eval {
    my $result = $api_instance->readTeam(teamId => $teamId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamApi->readTeam: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TeamApi()
teamId = teamId_example # String | The ID of the Kowabunga users team. (default to null)

try:
    api_response = api_instance.read_team(teamId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamApi->readTeam: %s\n" % e)
extern crate TeamApi;

pub fn main() {
    let teamId = teamId_example; // String

    let mut context = TeamApi::Context::default();
    let result = client.readTeam(teamId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
teamId*
String
The ID of the Kowabunga users team.
Required

Responses


updateTeam

Updates a Kowabunga users team configuration.


/team/{teamId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/team/{teamId}" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "users" : [ "users", "users" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TeamApi;

import java.io.File;
import java.util.*;

public class TeamApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TeamApi apiInstance = new TeamApi();
        String teamId = teamId_example; // String | The ID of the Kowabunga users team.
        Team team = ; // Team | 

        try {
            Team result = apiInstance.updateTeam(teamId, team);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#updateTeam");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String teamId = new String(); // String | The ID of the Kowabunga users team.
final Team team = new Team(); // Team | 

try {
    final result = await api_instance.updateTeam(teamId, team);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTeam: $e\n');
}

import org.openapitools.client.api.TeamApi;

public class TeamApiExample {
    public static void main(String[] args) {
        TeamApi apiInstance = new TeamApi();
        String teamId = teamId_example; // String | The ID of the Kowabunga users team.
        Team team = ; // Team | 

        try {
            Team result = apiInstance.updateTeam(teamId, team);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamApi#updateTeam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TeamApi *apiInstance = [[TeamApi alloc] init];
String *teamId = teamId_example; // The ID of the Kowabunga users team. (default to null)
Team *team = ; // 

[apiInstance updateTeamWith:teamId
    team:team
              completionHandler: ^(Team output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TeamApi()
var teamId = teamId_example; // {String} The ID of the Kowabunga users team.
var team = ; // {Team} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateTeam(teamId, team, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateTeamExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TeamApi();
            var teamId = teamId_example;  // String | The ID of the Kowabunga users team. (default to null)
            var team = new Team(); // Team | 

            try {
                Team result = apiInstance.updateTeam(teamId, team);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TeamApi.updateTeam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TeamApi();
$teamId = teamId_example; // String | The ID of the Kowabunga users team.
$team = ; // Team | 

try {
    $result = $api_instance->updateTeam($teamId, $team);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TeamApi->updateTeam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TeamApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TeamApi->new();
my $teamId = teamId_example; # String | The ID of the Kowabunga users team.
my $team = WWW::OPenAPIClient::Object::Team->new(); # Team | 

eval {
    my $result = $api_instance->updateTeam(teamId => $teamId, team => $team);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamApi->updateTeam: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TeamApi()
teamId = teamId_example # String | The ID of the Kowabunga users team. (default to null)
team =  # Team | 

try:
    api_response = api_instance.update_team(teamId, team)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamApi->updateTeam: %s\n" % e)
extern crate TeamApi;

pub fn main() {
    let teamId = teamId_example; // String
    let team = ; // Team

    let mut context = TeamApi::Context::default();
    let result = client.updateTeam(teamId, team, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
teamId*
String
The ID of the Kowabunga users team.
Required
Body parameters
Name Description
team *

Team payload.

Responses


Template

createTemplate

Creates a new image template.


/pool/{poolId}/template

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/pool/{poolId}/template" \
 -d '{
  "os" : "linux",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "source" : "source"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        Template template = ; // Template | 

        try {
            Template result = apiInstance.createTemplate(poolId, template);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#createTemplate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.
final Template template = new Template(); // Template | 

try {
    final result = await api_instance.createTemplate(poolId, template);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createTemplate: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        Template template = ; // Template | 

        try {
            Template result = apiInstance.createTemplate(poolId, template);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#createTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)
Template *template = ; // 

[apiInstance createTemplateWith:poolId
    template:template
              completionHandler: ^(Template output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TemplateApi()
var poolId = poolId_example; // {String} The ID of the storage pool.
var template = ; // {Template} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTemplate(poolId, template, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TemplateApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)
            var template = new Template(); // Template | 

            try {
                Template result = apiInstance.createTemplate(poolId, template);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.createTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();
$poolId = poolId_example; // String | The ID of the storage pool.
$template = ; // Template | 

try {
    $result = $api_instance->createTemplate($poolId, $template);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->createTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.
my $template = WWW::OPenAPIClient::Object::Template->new(); # Template | 

eval {
    my $result = $api_instance->createTemplate(poolId => $poolId, template => $template);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->createTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)
template =  # Template | 

try:
    api_response = api_instance.create_template(poolId, template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->createTemplate: %s\n" % e)
extern crate TemplateApi;

pub fn main() {
    let poolId = poolId_example; // String
    let template = ; // Template

    let mut context = TemplateApi::Context::default();
    let result = client.createTemplate(poolId, template, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required
Body parameters
Name Description
template *

Template payload.

Responses


deleteTemplate

Deletes an existing image template.


/template/{templateId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/template/{templateId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | The ID of the image template.

        try {
            apiInstance.deleteTemplate(templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#deleteTemplate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String templateId = new String(); // String | The ID of the image template.

try {
    final result = await api_instance.deleteTemplate(templateId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteTemplate: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | The ID of the image template.

        try {
            apiInstance.deleteTemplate(templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#deleteTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];
String *templateId = templateId_example; // The ID of the image template. (default to null)

[apiInstance deleteTemplateWith:templateId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TemplateApi()
var templateId = templateId_example; // {String} The ID of the image template.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTemplate(templateId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TemplateApi();
            var templateId = templateId_example;  // String | The ID of the image template. (default to null)

            try {
                apiInstance.deleteTemplate(templateId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.deleteTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();
$templateId = templateId_example; // String | The ID of the image template.

try {
    $api_instance->deleteTemplate($templateId);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->deleteTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();
my $templateId = templateId_example; # String | The ID of the image template.

eval {
    $api_instance->deleteTemplate(templateId => $templateId);
};
if ($@) {
    warn "Exception when calling TemplateApi->deleteTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()
templateId = templateId_example # String | The ID of the image template. (default to null)

try:
    api_instance.delete_template(templateId)
except ApiException as e:
    print("Exception when calling TemplateApi->deleteTemplate: %s\n" % e)
extern crate TemplateApi;

pub fn main() {
    let templateId = templateId_example; // String

    let mut context = TemplateApi::Context::default();
    let result = client.deleteTemplate(templateId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
templateId*
String
The ID of the image template.
Required

Responses


listStoragePoolTemplates

Returns the IDs of image template objects.


/pool/{poolId}/templates

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool/{poolId}/templates"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            array['String'] result = apiInstance.listStoragePoolTemplates(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#listStoragePoolTemplates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.

try {
    final result = await api_instance.listStoragePoolTemplates(poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStoragePoolTemplates: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            array['String'] result = apiInstance.listStoragePoolTemplates(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#listStoragePoolTemplates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)

[apiInstance listStoragePoolTemplatesWith:poolId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TemplateApi()
var poolId = poolId_example; // {String} The ID of the storage pool.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStoragePoolTemplates(poolId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listStoragePoolTemplatesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TemplateApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)

            try {
                array['String'] result = apiInstance.listStoragePoolTemplates(poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.listStoragePoolTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();
$poolId = poolId_example; // String | The ID of the storage pool.

try {
    $result = $api_instance->listStoragePoolTemplates($poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->listStoragePoolTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.

eval {
    my $result = $api_instance->listStoragePoolTemplates(poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->listStoragePoolTemplates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)

try:
    api_response = api_instance.list_storage_pool_templates(poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->listStoragePoolTemplates: %s\n" % e)
extern crate TemplateApi;

pub fn main() {
    let poolId = poolId_example; // String

    let mut context = TemplateApi::Context::default();
    let result = client.listStoragePoolTemplates(poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required

Responses


listTemplates

Returns the IDs of image template objects.


/template

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/template"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();

        try {
            array['String'] result = apiInstance.listTemplates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#listTemplates");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listTemplates();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listTemplates: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();

        try {
            array['String'] result = apiInstance.listTemplates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#listTemplates");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];

[apiInstance listTemplatesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TemplateApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listTemplates(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listTemplatesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TemplateApi();

            try {
                array['String'] result = apiInstance.listTemplates();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.listTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();

try {
    $result = $api_instance->listTemplates();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->listTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();

eval {
    my $result = $api_instance->listTemplates();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->listTemplates: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()

try:
    api_response = api_instance.list_templates()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->listTemplates: %s\n" % e)
extern crate TemplateApi;

pub fn main() {

    let mut context = TemplateApi::Context::default();
    let result = client.listTemplates(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readTemplate

Returns a image template.


/template/{templateId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/template/{templateId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | The ID of the image template.

        try {
            Template result = apiInstance.readTemplate(templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#readTemplate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String templateId = new String(); // String | The ID of the image template.

try {
    final result = await api_instance.readTemplate(templateId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readTemplate: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | The ID of the image template.

        try {
            Template result = apiInstance.readTemplate(templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#readTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];
String *templateId = templateId_example; // The ID of the image template. (default to null)

[apiInstance readTemplateWith:templateId
              completionHandler: ^(Template output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TemplateApi()
var templateId = templateId_example; // {String} The ID of the image template.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readTemplate(templateId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TemplateApi();
            var templateId = templateId_example;  // String | The ID of the image template. (default to null)

            try {
                Template result = apiInstance.readTemplate(templateId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.readTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();
$templateId = templateId_example; // String | The ID of the image template.

try {
    $result = $api_instance->readTemplate($templateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->readTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();
my $templateId = templateId_example; # String | The ID of the image template.

eval {
    my $result = $api_instance->readTemplate(templateId => $templateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->readTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()
templateId = templateId_example # String | The ID of the image template. (default to null)

try:
    api_response = api_instance.read_template(templateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->readTemplate: %s\n" % e)
extern crate TemplateApi;

pub fn main() {
    let templateId = templateId_example; // String

    let mut context = TemplateApi::Context::default();
    let result = client.readTemplate(templateId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
templateId*
String
The ID of the image template.
Required

Responses


setStoragePoolDefaultTemplate

Performs a storage pool setting of default template.


/pool/{poolId}/template/{templateId}/default

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool/{poolId}/template/{templateId}/default"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        String templateId = templateId_example; // String | The ID of the image template.

        try {
            apiInstance.setStoragePoolDefaultTemplate(poolId, templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#setStoragePoolDefaultTemplate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.
final String templateId = new String(); // String | The ID of the image template.

try {
    final result = await api_instance.setStoragePoolDefaultTemplate(poolId, templateId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setStoragePoolDefaultTemplate: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String poolId = poolId_example; // String | The ID of the storage pool.
        String templateId = templateId_example; // String | The ID of the image template.

        try {
            apiInstance.setStoragePoolDefaultTemplate(poolId, templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#setStoragePoolDefaultTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)
String *templateId = templateId_example; // The ID of the image template. (default to null)

[apiInstance setStoragePoolDefaultTemplateWith:poolId
    templateId:templateId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TemplateApi()
var poolId = poolId_example; // {String} The ID of the storage pool.
var templateId = templateId_example; // {String} The ID of the image template.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setStoragePoolDefaultTemplate(poolId, templateId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setStoragePoolDefaultTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TemplateApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)
            var templateId = templateId_example;  // String | The ID of the image template. (default to null)

            try {
                apiInstance.setStoragePoolDefaultTemplate(poolId, templateId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.setStoragePoolDefaultTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();
$poolId = poolId_example; // String | The ID of the storage pool.
$templateId = templateId_example; // String | The ID of the image template.

try {
    $api_instance->setStoragePoolDefaultTemplate($poolId, $templateId);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->setStoragePoolDefaultTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.
my $templateId = templateId_example; # String | The ID of the image template.

eval {
    $api_instance->setStoragePoolDefaultTemplate(poolId => $poolId, templateId => $templateId);
};
if ($@) {
    warn "Exception when calling TemplateApi->setStoragePoolDefaultTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)
templateId = templateId_example # String | The ID of the image template. (default to null)

try:
    api_instance.set_storage_pool_default_template(poolId, templateId)
except ApiException as e:
    print("Exception when calling TemplateApi->setStoragePoolDefaultTemplate: %s\n" % e)
extern crate TemplateApi;

pub fn main() {
    let poolId = poolId_example; // String
    let templateId = templateId_example; // String

    let mut context = TemplateApi::Context::default();
    let result = client.setStoragePoolDefaultTemplate(poolId, templateId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required
templateId*
String
The ID of the image template.
Required

Responses


updateTemplate

Updates a image template configuration.


/template/{templateId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/template/{templateId}" \
 -d '{
  "os" : "linux",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "source" : "source"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateApi;

import java.io.File;
import java.util.*;

public class TemplateApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | The ID of the image template.
        Template template = ; // Template | 

        try {
            Template result = apiInstance.updateTemplate(templateId, template);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#updateTemplate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String templateId = new String(); // String | The ID of the image template.
final Template template = new Template(); // Template | 

try {
    final result = await api_instance.updateTemplate(templateId, template);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateTemplate: $e\n');
}

import org.openapitools.client.api.TemplateApi;

public class TemplateApiExample {
    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | The ID of the image template.
        Template template = ; // Template | 

        try {
            Template result = apiInstance.updateTemplate(templateId, template);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#updateTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TemplateApi *apiInstance = [[TemplateApi alloc] init];
String *templateId = templateId_example; // The ID of the image template. (default to null)
Template *template = ; // 

[apiInstance updateTemplateWith:templateId
    template:template
              completionHandler: ^(Template output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TemplateApi()
var templateId = templateId_example; // {String} The ID of the image template.
var template = ; // {Template} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateTemplate(templateId, template, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateTemplateExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TemplateApi();
            var templateId = templateId_example;  // String | The ID of the image template. (default to null)
            var template = new Template(); // Template | 

            try {
                Template result = apiInstance.updateTemplate(templateId, template);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TemplateApi.updateTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TemplateApi();
$templateId = templateId_example; // String | The ID of the image template.
$template = ; // Template | 

try {
    $result = $api_instance->updateTemplate($templateId, $template);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->updateTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TemplateApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TemplateApi->new();
my $templateId = templateId_example; # String | The ID of the image template.
my $template = WWW::OPenAPIClient::Object::Template->new(); # Template | 

eval {
    my $result = $api_instance->updateTemplate(templateId => $templateId, template => $template);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->updateTemplate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TemplateApi()
templateId = templateId_example # String | The ID of the image template. (default to null)
template =  # Template | 

try:
    api_response = api_instance.update_template(templateId, template)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->updateTemplate: %s\n" % e)
extern crate TemplateApi;

pub fn main() {
    let templateId = templateId_example; // String
    let template = ; // Template

    let mut context = TemplateApi::Context::default();
    let result = client.updateTemplate(templateId, template, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
templateId*
String
The ID of the image template.
Required
Body parameters
Name Description
template *

Template payload.

Responses


Token

deleteApiToken

Deletes an existing server-to-server authentication security token.


/token/{tokenId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/token/{tokenId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TokenApi;

import java.io.File;
import java.util.*;

public class TokenApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TokenApi apiInstance = new TokenApi();
        String tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.

        try {
            apiInstance.deleteApiToken(tokenId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#deleteApiToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tokenId = new String(); // String | The ID of the server-to-server authentication security token.

try {
    final result = await api_instance.deleteApiToken(tokenId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteApiToken: $e\n');
}

import org.openapitools.client.api.TokenApi;

public class TokenApiExample {
    public static void main(String[] args) {
        TokenApi apiInstance = new TokenApi();
        String tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.

        try {
            apiInstance.deleteApiToken(tokenId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#deleteApiToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TokenApi *apiInstance = [[TokenApi alloc] init];
String *tokenId = tokenId_example; // The ID of the server-to-server authentication security token. (default to null)

[apiInstance deleteApiTokenWith:tokenId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TokenApi()
var tokenId = tokenId_example; // {String} The ID of the server-to-server authentication security token.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteApiToken(tokenId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteApiTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TokenApi();
            var tokenId = tokenId_example;  // String | The ID of the server-to-server authentication security token. (default to null)

            try {
                apiInstance.deleteApiToken(tokenId);
            } catch (Exception e) {
                Debug.Print("Exception when calling TokenApi.deleteApiToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TokenApi();
$tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.

try {
    $api_instance->deleteApiToken($tokenId);
} catch (Exception $e) {
    echo 'Exception when calling TokenApi->deleteApiToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TokenApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TokenApi->new();
my $tokenId = tokenId_example; # String | The ID of the server-to-server authentication security token.

eval {
    $api_instance->deleteApiToken(tokenId => $tokenId);
};
if ($@) {
    warn "Exception when calling TokenApi->deleteApiToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TokenApi()
tokenId = tokenId_example # String | The ID of the server-to-server authentication security token. (default to null)

try:
    api_instance.delete_api_token(tokenId)
except ApiException as e:
    print("Exception when calling TokenApi->deleteApiToken: %s\n" % e)
extern crate TokenApi;

pub fn main() {
    let tokenId = tokenId_example; // String

    let mut context = TokenApi::Context::default();
    let result = client.deleteApiToken(tokenId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tokenId*
String
The ID of the server-to-server authentication security token.
Required

Responses


listApiTokens

Returns the IDs of server-to-server authentication security token objects.


/token

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/token"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TokenApi;

import java.io.File;
import java.util.*;

public class TokenApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TokenApi apiInstance = new TokenApi();

        try {
            array['String'] result = apiInstance.listApiTokens();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#listApiTokens");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listApiTokens();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listApiTokens: $e\n');
}

import org.openapitools.client.api.TokenApi;

public class TokenApiExample {
    public static void main(String[] args) {
        TokenApi apiInstance = new TokenApi();

        try {
            array['String'] result = apiInstance.listApiTokens();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#listApiTokens");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TokenApi *apiInstance = [[TokenApi alloc] init];

[apiInstance listApiTokensWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TokenApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listApiTokens(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listApiTokensExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TokenApi();

            try {
                array['String'] result = apiInstance.listApiTokens();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TokenApi.listApiTokens: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TokenApi();

try {
    $result = $api_instance->listApiTokens();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TokenApi->listApiTokens: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TokenApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TokenApi->new();

eval {
    my $result = $api_instance->listApiTokens();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TokenApi->listApiTokens: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TokenApi()

try:
    api_response = api_instance.list_api_tokens()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TokenApi->listApiTokens: %s\n" % e)
extern crate TokenApi;

pub fn main() {

    let mut context = TokenApi::Context::default();
    let result = client.listApiTokens(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readApiToken

Returns a server-to-server authentication security token.


/token/{tokenId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/token/{tokenId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TokenApi;

import java.io.File;
import java.util.*;

public class TokenApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TokenApi apiInstance = new TokenApi();
        String tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.

        try {
            ApiToken result = apiInstance.readApiToken(tokenId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#readApiToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tokenId = new String(); // String | The ID of the server-to-server authentication security token.

try {
    final result = await api_instance.readApiToken(tokenId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readApiToken: $e\n');
}

import org.openapitools.client.api.TokenApi;

public class TokenApiExample {
    public static void main(String[] args) {
        TokenApi apiInstance = new TokenApi();
        String tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.

        try {
            ApiToken result = apiInstance.readApiToken(tokenId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#readApiToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TokenApi *apiInstance = [[TokenApi alloc] init];
String *tokenId = tokenId_example; // The ID of the server-to-server authentication security token. (default to null)

[apiInstance readApiTokenWith:tokenId
              completionHandler: ^(ApiToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TokenApi()
var tokenId = tokenId_example; // {String} The ID of the server-to-server authentication security token.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readApiToken(tokenId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readApiTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TokenApi();
            var tokenId = tokenId_example;  // String | The ID of the server-to-server authentication security token. (default to null)

            try {
                ApiToken result = apiInstance.readApiToken(tokenId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TokenApi.readApiToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TokenApi();
$tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.

try {
    $result = $api_instance->readApiToken($tokenId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TokenApi->readApiToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TokenApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TokenApi->new();
my $tokenId = tokenId_example; # String | The ID of the server-to-server authentication security token.

eval {
    my $result = $api_instance->readApiToken(tokenId => $tokenId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TokenApi->readApiToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TokenApi()
tokenId = tokenId_example # String | The ID of the server-to-server authentication security token. (default to null)

try:
    api_response = api_instance.read_api_token(tokenId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TokenApi->readApiToken: %s\n" % e)
extern crate TokenApi;

pub fn main() {
    let tokenId = tokenId_example; // String

    let mut context = TokenApi::Context::default();
    let result = client.readApiToken(tokenId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tokenId*
String
The ID of the server-to-server authentication security token.
Required

Responses


setAgentApiToken

Performs a Kowabunga remote agent setting of API token (will replace any existing one).


/agent/{agentId}/token

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/agent/{agentId}/token?expire=true&expiration_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TokenApi;

import java.io.File;
import java.util.*;

public class TokenApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TokenApi apiInstance = new TokenApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
        Boolean expire = true; // Boolean | Whether or not the token should expire.
        date expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

        try {
            ApiToken result = apiInstance.setAgentApiToken(agentId, expire, expirationDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#setAgentApiToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String agentId = new String(); // String | The ID of the Kowabunga remote agent.
final Boolean expire = new Boolean(); // Boolean | Whether or not the token should expire.
final date expirationDate = new date(); // date | Token's expiration date (YYYY-MM-DD format).

try {
    final result = await api_instance.setAgentApiToken(agentId, expire, expirationDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setAgentApiToken: $e\n');
}

import org.openapitools.client.api.TokenApi;

public class TokenApiExample {
    public static void main(String[] args) {
        TokenApi apiInstance = new TokenApi();
        String agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
        Boolean expire = true; // Boolean | Whether or not the token should expire.
        date expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

        try {
            ApiToken result = apiInstance.setAgentApiToken(agentId, expire, expirationDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#setAgentApiToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TokenApi *apiInstance = [[TokenApi alloc] init];
String *agentId = agentId_example; // The ID of the Kowabunga remote agent. (default to null)
Boolean *expire = true; // Whether or not the token should expire. (optional) (default to null)
date *expirationDate = 2013-10-20; // Token's expiration date (YYYY-MM-DD format). (optional) (default to null)

[apiInstance setAgentApiTokenWith:agentId
    expire:expire
    expirationDate:expirationDate
              completionHandler: ^(ApiToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TokenApi()
var agentId = agentId_example; // {String} The ID of the Kowabunga remote agent.
var opts = {
  'expire': true, // {Boolean} Whether or not the token should expire.
  'expirationDate': 2013-10-20 // {date} Token's expiration date (YYYY-MM-DD format).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setAgentApiToken(agentId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setAgentApiTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TokenApi();
            var agentId = agentId_example;  // String | The ID of the Kowabunga remote agent. (default to null)
            var expire = true;  // Boolean | Whether or not the token should expire. (optional)  (default to null)
            var expirationDate = 2013-10-20;  // date | Token's expiration date (YYYY-MM-DD format). (optional)  (default to null)

            try {
                ApiToken result = apiInstance.setAgentApiToken(agentId, expire, expirationDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TokenApi.setAgentApiToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TokenApi();
$agentId = agentId_example; // String | The ID of the Kowabunga remote agent.
$expire = true; // Boolean | Whether or not the token should expire.
$expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

try {
    $result = $api_instance->setAgentApiToken($agentId, $expire, $expirationDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TokenApi->setAgentApiToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TokenApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TokenApi->new();
my $agentId = agentId_example; # String | The ID of the Kowabunga remote agent.
my $expire = true; # Boolean | Whether or not the token should expire.
my $expirationDate = 2013-10-20; # date | Token's expiration date (YYYY-MM-DD format).

eval {
    my $result = $api_instance->setAgentApiToken(agentId => $agentId, expire => $expire, expirationDate => $expirationDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TokenApi->setAgentApiToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TokenApi()
agentId = agentId_example # String | The ID of the Kowabunga remote agent. (default to null)
expire = true # Boolean | Whether or not the token should expire. (optional) (default to null)
expirationDate = 2013-10-20 # date | Token's expiration date (YYYY-MM-DD format). (optional) (default to null)

try:
    api_response = api_instance.set_agent_api_token(agentId, expire=expire, expirationDate=expirationDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TokenApi->setAgentApiToken: %s\n" % e)
extern crate TokenApi;

pub fn main() {
    let agentId = agentId_example; // String
    let expire = true; // Boolean
    let expirationDate = 2013-10-20; // date

    let mut context = TokenApi::Context::default();
    let result = client.setAgentApiToken(agentId, expire, expirationDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
agentId*
String
The ID of the Kowabunga remote agent.
Required
Query parameters
Name Description
expire
Boolean
Whether or not the token should expire.
expiration_date
date (date)
Token's expiration date (YYYY-MM-DD format).

Responses


setUserApiToken

Performs a Kowabunga user setting of API token (will replace any existing one).


/user/{userId}/token

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/user/{userId}/token?expire=true&expiration_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TokenApi;

import java.io.File;
import java.util.*;

public class TokenApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TokenApi apiInstance = new TokenApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.
        Boolean expire = true; // Boolean | Whether or not the token should expire.
        date expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

        try {
            apiInstance.setUserApiToken(userId, expire, expirationDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#setUserApiToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | The ID of the Kowabunga user.
final Boolean expire = new Boolean(); // Boolean | Whether or not the token should expire.
final date expirationDate = new date(); // date | Token's expiration date (YYYY-MM-DD format).

try {
    final result = await api_instance.setUserApiToken(userId, expire, expirationDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setUserApiToken: $e\n');
}

import org.openapitools.client.api.TokenApi;

public class TokenApiExample {
    public static void main(String[] args) {
        TokenApi apiInstance = new TokenApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.
        Boolean expire = true; // Boolean | Whether or not the token should expire.
        date expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

        try {
            apiInstance.setUserApiToken(userId, expire, expirationDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#setUserApiToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TokenApi *apiInstance = [[TokenApi alloc] init];
String *userId = userId_example; // The ID of the Kowabunga user. (default to null)
Boolean *expire = true; // Whether or not the token should expire. (optional) (default to null)
date *expirationDate = 2013-10-20; // Token's expiration date (YYYY-MM-DD format). (optional) (default to null)

[apiInstance setUserApiTokenWith:userId
    expire:expire
    expirationDate:expirationDate
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TokenApi()
var userId = userId_example; // {String} The ID of the Kowabunga user.
var opts = {
  'expire': true, // {Boolean} Whether or not the token should expire.
  'expirationDate': 2013-10-20 // {date} Token's expiration date (YYYY-MM-DD format).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setUserApiToken(userId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setUserApiTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TokenApi();
            var userId = userId_example;  // String | The ID of the Kowabunga user. (default to null)
            var expire = true;  // Boolean | Whether or not the token should expire. (optional)  (default to null)
            var expirationDate = 2013-10-20;  // date | Token's expiration date (YYYY-MM-DD format). (optional)  (default to null)

            try {
                apiInstance.setUserApiToken(userId, expire, expirationDate);
            } catch (Exception e) {
                Debug.Print("Exception when calling TokenApi.setUserApiToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TokenApi();
$userId = userId_example; // String | The ID of the Kowabunga user.
$expire = true; // Boolean | Whether or not the token should expire.
$expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

try {
    $api_instance->setUserApiToken($userId, $expire, $expirationDate);
} catch (Exception $e) {
    echo 'Exception when calling TokenApi->setUserApiToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TokenApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TokenApi->new();
my $userId = userId_example; # String | The ID of the Kowabunga user.
my $expire = true; # Boolean | Whether or not the token should expire.
my $expirationDate = 2013-10-20; # date | Token's expiration date (YYYY-MM-DD format).

eval {
    $api_instance->setUserApiToken(userId => $userId, expire => $expire, expirationDate => $expirationDate);
};
if ($@) {
    warn "Exception when calling TokenApi->setUserApiToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TokenApi()
userId = userId_example # String | The ID of the Kowabunga user. (default to null)
expire = true # Boolean | Whether or not the token should expire. (optional) (default to null)
expirationDate = 2013-10-20 # date | Token's expiration date (YYYY-MM-DD format). (optional) (default to null)

try:
    api_instance.set_user_api_token(userId, expire=expire, expirationDate=expirationDate)
except ApiException as e:
    print("Exception when calling TokenApi->setUserApiToken: %s\n" % e)
extern crate TokenApi;

pub fn main() {
    let userId = userId_example; // String
    let expire = true; // Boolean
    let expirationDate = 2013-10-20; // date

    let mut context = TokenApi::Context::default();
    let result = client.setUserApiToken(userId, expire, expirationDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
The ID of the Kowabunga user.
Required
Query parameters
Name Description
expire
Boolean
Whether or not the token should expire.
expiration_date
date (date)
Token's expiration date (YYYY-MM-DD format).

Responses


updateApiToken

Updates a server-to-server authentication security token configuration.


/token/{tokenId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/token/{tokenId}" \
 -d '{
  "expire" : false,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "expiration_date" : "2000-01-23"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TokenApi;

import java.io.File;
import java.util.*;

public class TokenApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        TokenApi apiInstance = new TokenApi();
        String tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.
        ApiToken apiToken = ; // ApiToken | 

        try {
            ApiToken result = apiInstance.updateApiToken(tokenId, apiToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#updateApiToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String tokenId = new String(); // String | The ID of the server-to-server authentication security token.
final ApiToken apiToken = new ApiToken(); // ApiToken | 

try {
    final result = await api_instance.updateApiToken(tokenId, apiToken);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateApiToken: $e\n');
}

import org.openapitools.client.api.TokenApi;

public class TokenApiExample {
    public static void main(String[] args) {
        TokenApi apiInstance = new TokenApi();
        String tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.
        ApiToken apiToken = ; // ApiToken | 

        try {
            ApiToken result = apiInstance.updateApiToken(tokenId, apiToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TokenApi#updateApiToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
TokenApi *apiInstance = [[TokenApi alloc] init];
String *tokenId = tokenId_example; // The ID of the server-to-server authentication security token. (default to null)
ApiToken *apiToken = ; // 

[apiInstance updateApiTokenWith:tokenId
    apiToken:apiToken
              completionHandler: ^(ApiToken output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.TokenApi()
var tokenId = tokenId_example; // {String} The ID of the server-to-server authentication security token.
var apiToken = ; // {ApiToken} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateApiToken(tokenId, apiToken, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateApiTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new TokenApi();
            var tokenId = tokenId_example;  // String | The ID of the server-to-server authentication security token. (default to null)
            var apiToken = new ApiToken(); // ApiToken | 

            try {
                ApiToken result = apiInstance.updateApiToken(tokenId, apiToken);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TokenApi.updateApiToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TokenApi();
$tokenId = tokenId_example; // String | The ID of the server-to-server authentication security token.
$apiToken = ; // ApiToken | 

try {
    $result = $api_instance->updateApiToken($tokenId, $apiToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TokenApi->updateApiToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TokenApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TokenApi->new();
my $tokenId = tokenId_example; # String | The ID of the server-to-server authentication security token.
my $apiToken = WWW::OPenAPIClient::Object::ApiToken->new(); # ApiToken | 

eval {
    my $result = $api_instance->updateApiToken(tokenId => $tokenId, apiToken => $apiToken);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TokenApi->updateApiToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.TokenApi()
tokenId = tokenId_example # String | The ID of the server-to-server authentication security token. (default to null)
apiToken =  # ApiToken | 

try:
    api_response = api_instance.update_api_token(tokenId, apiToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TokenApi->updateApiToken: %s\n" % e)
extern crate TokenApi;

pub fn main() {
    let tokenId = tokenId_example; // String
    let apiToken = ; // ApiToken

    let mut context = TokenApi::Context::default();
    let result = client.updateApiToken(tokenId, apiToken, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
tokenId*
String
The ID of the server-to-server authentication security token.
Required
Body parameters
Name Description
apiToken *

ApiToken payload.

Responses


User

createUser

Creates a new Kowabunga user.


/user

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/user" \
 -d '{
  "role" : "superAdmin",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "email" : "email",
  "notifications" : false
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        User user = ; // User | 

        try {
            User result = apiInstance.createUser(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final User user = new User(); // User | 

try {
    final result = await api_instance.createUser(user);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createUser: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        User user = ; // User | 

        try {
            User result = apiInstance.createUser(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#createUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
User *user = ; // 

[apiInstance createUserWith:user
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var user = ; // {User} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createUser(user, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var user = new User(); // User | 

            try {
                User result = apiInstance.createUser(user);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$user = ; // User | 

try {
    $result = $api_instance->createUser($user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->createUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $user = WWW::OPenAPIClient::Object::User->new(); # User | 

eval {
    my $result = $api_instance->createUser(user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->createUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
user =  # User | 

try:
    api_response = api_instance.create_user(user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->createUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let user = ; // User

    let mut context = UserApi::Context::default();
    let result = client.createUser(user, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
user *

User payload.

Responses


deleteUser

Deletes an existing Kowabunga user.


/user/{userId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/user/{userId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.

        try {
            apiInstance.deleteUser(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | The ID of the Kowabunga user.

try {
    final result = await api_instance.deleteUser(userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteUser: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.

        try {
            apiInstance.deleteUser(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#deleteUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userId = userId_example; // The ID of the Kowabunga user. (default to null)

[apiInstance deleteUserWith:userId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var userId = userId_example; // {String} The ID of the Kowabunga user.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteUser(userId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userId = userId_example;  // String | The ID of the Kowabunga user. (default to null)

            try {
                apiInstance.deleteUser(userId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.deleteUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userId = userId_example; // String | The ID of the Kowabunga user.

try {
    $api_instance->deleteUser($userId);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userId = userId_example; # String | The ID of the Kowabunga user.

eval {
    $api_instance->deleteUser(userId => $userId);
};
if ($@) {
    warn "Exception when calling UserApi->deleteUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userId = userId_example # String | The ID of the Kowabunga user. (default to null)

try:
    api_instance.delete_user(userId)
except ApiException as e:
    print("Exception when calling UserApi->deleteUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userId = userId_example; // String

    let mut context = UserApi::Context::default();
    let result = client.deleteUser(userId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
The ID of the Kowabunga user.
Required

Responses


listUsers

Returns the IDs of Kowabunga user objects.


/user

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/user"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();

        try {
            array['String'] result = apiInstance.listUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#listUsers");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listUsers();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listUsers: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();

        try {
            array['String'] result = apiInstance.listUsers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#listUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

[apiInstance listUsersWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUsers(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listUsersExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                array['String'] result = apiInstance.listUsers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.listUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $result = $api_instance->listUsers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->listUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval {
    my $result = $api_instance->listUsers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->listUsers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try:
    api_response = api_instance.list_users()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->listUsers: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.listUsers(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


login

Creates a new Kowabunga user login credentials.


/login

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/login" \
 -d '{
  "password" : "password",
  "jwt" : "jwt",
  "email" : "email"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        UserCredentials userCredentials = ; // UserCredentials | 

        try {
            UserCredentials result = apiInstance.login(userCredentials);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#login");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserCredentials userCredentials = new UserCredentials(); // UserCredentials | 

try {
    final result = await api_instance.login(userCredentials);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->login: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        UserCredentials userCredentials = ; // UserCredentials | 

        try {
            UserCredentials result = apiInstance.login(userCredentials);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#login");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
UserCredentials *userCredentials = ; // 

[apiInstance loginWith:userCredentials
              completionHandler: ^(UserCredentials output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var userCredentials = ; // {UserCredentials} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(userCredentials, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userCredentials = new UserCredentials(); // UserCredentials | 

            try {
                UserCredentials result = apiInstance.login(userCredentials);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userCredentials = ; // UserCredentials | 

try {
    $result = $api_instance->login($userCredentials);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userCredentials = WWW::OPenAPIClient::Object::UserCredentials->new(); # UserCredentials | 

eval {
    my $result = $api_instance->login(userCredentials => $userCredentials);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->login: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userCredentials =  # UserCredentials | 

try:
    api_response = api_instance.login(userCredentials)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->login: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userCredentials = ; // UserCredentials

    let mut context = UserApi::Context::default();
    let result = client.login(userCredentials, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userCredentials *

UserCredentials payload.

Responses


logout

Creates a new Kowabunga user logout session.


/logout

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/logout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();

        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#logout");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.logout();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->logout: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();

        try {
            apiInstance.logout();
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#logout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];

[apiInstance logoutWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.logout(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class logoutExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();

            try {
                apiInstance.logout();
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();

try {
    $api_instance->logout();
} catch (Exception $e) {
    echo 'Exception when calling UserApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();

eval {
    $api_instance->logout();
};
if ($@) {
    warn "Exception when calling UserApi->logout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()

try:
    api_instance.logout()
except ApiException as e:
    print("Exception when calling UserApi->logout: %s\n" % e)
extern crate UserApi;

pub fn main() {

    let mut context = UserApi::Context::default();
    let result = client.logout(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readUser

Returns a Kowabunga user.


/user/{userId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/user/{userId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.

        try {
            User result = apiInstance.readUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#readUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | The ID of the Kowabunga user.

try {
    final result = await api_instance.readUser(userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readUser: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.

        try {
            User result = apiInstance.readUser(userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#readUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userId = userId_example; // The ID of the Kowabunga user. (default to null)

[apiInstance readUserWith:userId
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var userId = userId_example; // {String} The ID of the Kowabunga user.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readUser(userId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userId = userId_example;  // String | The ID of the Kowabunga user. (default to null)

            try {
                User result = apiInstance.readUser(userId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.readUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userId = userId_example; // String | The ID of the Kowabunga user.

try {
    $result = $api_instance->readUser($userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->readUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userId = userId_example; # String | The ID of the Kowabunga user.

eval {
    my $result = $api_instance->readUser(userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->readUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userId = userId_example # String | The ID of the Kowabunga user. (default to null)

try:
    api_response = api_instance.read_user(userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->readUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userId = userId_example; // String

    let mut context = UserApi::Context::default();
    let result = client.readUser(userId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
The ID of the Kowabunga user.
Required

Responses


resetPassword

Updates a Kowabunga userreset of password for the provided email (server-side generated, will replace any existing one) configuration.


/resetPassword

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/resetPassword" \
 -d '{
  "email" : "email"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        UserEmail userEmail = ; // UserEmail | 

        try {
            apiInstance.resetPassword(userEmail);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#resetPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final UserEmail userEmail = new UserEmail(); // UserEmail | 

try {
    final result = await api_instance.resetPassword(userEmail);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resetPassword: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        UserEmail userEmail = ; // UserEmail | 

        try {
            apiInstance.resetPassword(userEmail);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#resetPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
UserEmail *userEmail = ; // 

[apiInstance resetPasswordWith:userEmail
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var userEmail = ; // {UserEmail} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetPassword(userEmail, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class resetPasswordExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userEmail = new UserEmail(); // UserEmail | 

            try {
                apiInstance.resetPassword(userEmail);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.resetPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userEmail = ; // UserEmail | 

try {
    $api_instance->resetPassword($userEmail);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->resetPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userEmail = WWW::OPenAPIClient::Object::UserEmail->new(); # UserEmail | 

eval {
    $api_instance->resetPassword(userEmail => $userEmail);
};
if ($@) {
    warn "Exception when calling UserApi->resetPassword: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userEmail =  # UserEmail | 

try:
    api_instance.reset_password(userEmail)
except ApiException as e:
    print("Exception when calling UserApi->resetPassword: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userEmail = ; // UserEmail

    let mut context = UserApi::Context::default();
    let result = client.resetPassword(userEmail, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userEmail *

UserEmail payload.

Responses


resetUserPassword

Performs a Kowabunga user reset of password (server-side generated, will replace any existing one).


/user/{userId}/resetPassword

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/user/{userId}/resetPassword"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.

        try {
            apiInstance.resetUserPassword(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#resetUserPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | The ID of the Kowabunga user.

try {
    final result = await api_instance.resetUserPassword(userId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->resetUserPassword: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.

        try {
            apiInstance.resetUserPassword(userId);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#resetUserPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userId = userId_example; // The ID of the Kowabunga user. (default to null)

[apiInstance resetUserPasswordWith:userId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var userId = userId_example; // {String} The ID of the Kowabunga user.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetUserPassword(userId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class resetUserPasswordExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userId = userId_example;  // String | The ID of the Kowabunga user. (default to null)

            try {
                apiInstance.resetUserPassword(userId);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.resetUserPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userId = userId_example; // String | The ID of the Kowabunga user.

try {
    $api_instance->resetUserPassword($userId);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->resetUserPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userId = userId_example; # String | The ID of the Kowabunga user.

eval {
    $api_instance->resetUserPassword(userId => $userId);
};
if ($@) {
    warn "Exception when calling UserApi->resetUserPassword: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userId = userId_example # String | The ID of the Kowabunga user. (default to null)

try:
    api_instance.reset_user_password(userId)
except ApiException as e:
    print("Exception when calling UserApi->resetUserPassword: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userId = userId_example; // String

    let mut context = UserApi::Context::default();
    let result = client.resetUserPassword(userId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
The ID of the Kowabunga user.
Required

Responses


setUserApiToken

Performs a Kowabunga user setting of API token (will replace any existing one).


/user/{userId}/token

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/user/{userId}/token?expire=true&expiration_date=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.
        Boolean expire = true; // Boolean | Whether or not the token should expire.
        date expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

        try {
            apiInstance.setUserApiToken(userId, expire, expirationDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#setUserApiToken");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | The ID of the Kowabunga user.
final Boolean expire = new Boolean(); // Boolean | Whether or not the token should expire.
final date expirationDate = new date(); // date | Token's expiration date (YYYY-MM-DD format).

try {
    final result = await api_instance.setUserApiToken(userId, expire, expirationDate);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setUserApiToken: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.
        Boolean expire = true; // Boolean | Whether or not the token should expire.
        date expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

        try {
            apiInstance.setUserApiToken(userId, expire, expirationDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#setUserApiToken");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userId = userId_example; // The ID of the Kowabunga user. (default to null)
Boolean *expire = true; // Whether or not the token should expire. (optional) (default to null)
date *expirationDate = 2013-10-20; // Token's expiration date (YYYY-MM-DD format). (optional) (default to null)

[apiInstance setUserApiTokenWith:userId
    expire:expire
    expirationDate:expirationDate
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var userId = userId_example; // {String} The ID of the Kowabunga user.
var opts = {
  'expire': true, // {Boolean} Whether or not the token should expire.
  'expirationDate': 2013-10-20 // {date} Token's expiration date (YYYY-MM-DD format).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setUserApiToken(userId, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setUserApiTokenExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userId = userId_example;  // String | The ID of the Kowabunga user. (default to null)
            var expire = true;  // Boolean | Whether or not the token should expire. (optional)  (default to null)
            var expirationDate = 2013-10-20;  // date | Token's expiration date (YYYY-MM-DD format). (optional)  (default to null)

            try {
                apiInstance.setUserApiToken(userId, expire, expirationDate);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.setUserApiToken: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userId = userId_example; // String | The ID of the Kowabunga user.
$expire = true; // Boolean | Whether or not the token should expire.
$expirationDate = 2013-10-20; // date | Token's expiration date (YYYY-MM-DD format).

try {
    $api_instance->setUserApiToken($userId, $expire, $expirationDate);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->setUserApiToken: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userId = userId_example; # String | The ID of the Kowabunga user.
my $expire = true; # Boolean | Whether or not the token should expire.
my $expirationDate = 2013-10-20; # date | Token's expiration date (YYYY-MM-DD format).

eval {
    $api_instance->setUserApiToken(userId => $userId, expire => $expire, expirationDate => $expirationDate);
};
if ($@) {
    warn "Exception when calling UserApi->setUserApiToken: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userId = userId_example # String | The ID of the Kowabunga user. (default to null)
expire = true # Boolean | Whether or not the token should expire. (optional) (default to null)
expirationDate = 2013-10-20 # date | Token's expiration date (YYYY-MM-DD format). (optional) (default to null)

try:
    api_instance.set_user_api_token(userId, expire=expire, expirationDate=expirationDate)
except ApiException as e:
    print("Exception when calling UserApi->setUserApiToken: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userId = userId_example; // String
    let expire = true; // Boolean
    let expirationDate = 2013-10-20; // date

    let mut context = UserApi::Context::default();
    let result = client.setUserApiToken(userId, expire, expirationDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
The ID of the Kowabunga user.
Required
Query parameters
Name Description
expire
Boolean
Whether or not the token should expire.
expiration_date
date (date)
Token's expiration date (YYYY-MM-DD format).

Responses


setUserPassword

Updates a Kowabunga user password (will replace any existing one) configuration.


/user/{userId}/password

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/user/{userId}/password" \
 -d '{
  "value" : "value"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.
        Password password = ; // Password | 

        try {
            apiInstance.setUserPassword(userId, password);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#setUserPassword");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | The ID of the Kowabunga user.
final Password password = new Password(); // Password | 

try {
    final result = await api_instance.setUserPassword(userId, password);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setUserPassword: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.
        Password password = ; // Password | 

        try {
            apiInstance.setUserPassword(userId, password);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#setUserPassword");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userId = userId_example; // The ID of the Kowabunga user. (default to null)
Password *password = ; // 

[apiInstance setUserPasswordWith:userId
    password:password
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var userId = userId_example; // {String} The ID of the Kowabunga user.
var password = ; // {Password} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setUserPassword(userId, password, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setUserPasswordExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userId = userId_example;  // String | The ID of the Kowabunga user. (default to null)
            var password = new Password(); // Password | 

            try {
                apiInstance.setUserPassword(userId, password);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.setUserPassword: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userId = userId_example; // String | The ID of the Kowabunga user.
$password = ; // Password | 

try {
    $api_instance->setUserPassword($userId, $password);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->setUserPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userId = userId_example; # String | The ID of the Kowabunga user.
my $password = WWW::OPenAPIClient::Object::Password->new(); # Password | 

eval {
    $api_instance->setUserPassword(userId => $userId, password => $password);
};
if ($@) {
    warn "Exception when calling UserApi->setUserPassword: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userId = userId_example # String | The ID of the Kowabunga user. (default to null)
password =  # Password | 

try:
    api_instance.set_user_password(userId, password)
except ApiException as e:
    print("Exception when calling UserApi->setUserPassword: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userId = userId_example; // String
    let password = ; // Password

    let mut context = UserApi::Context::default();
    let result = client.setUserPassword(userId, password, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
The ID of the Kowabunga user.
Required
Body parameters
Name Description
password *

Password payload.

Responses


updateUser

Updates a Kowabunga user configuration.


/user/{userId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/user/{userId}" \
 -d '{
  "role" : "superAdmin",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "email" : "email",
  "notifications" : false
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserApi;

import java.io.File;
import java.util.*;

public class UserApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.
        User user = ; // User | 

        try {
            User result = apiInstance.updateUser(userId, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String userId = new String(); // String | The ID of the Kowabunga user.
final User user = new User(); // User | 

try {
    final result = await api_instance.updateUser(userId, user);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateUser: $e\n');
}

import org.openapitools.client.api.UserApi;

public class UserApiExample {
    public static void main(String[] args) {
        UserApi apiInstance = new UserApi();
        String userId = userId_example; // String | The ID of the Kowabunga user.
        User user = ; // User | 

        try {
            User result = apiInstance.updateUser(userId, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#updateUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
UserApi *apiInstance = [[UserApi alloc] init];
String *userId = userId_example; // The ID of the Kowabunga user. (default to null)
User *user = ; // 

[apiInstance updateUserWith:userId
    user:user
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.UserApi()
var userId = userId_example; // {String} The ID of the Kowabunga user.
var user = ; // {User} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUser(userId, user, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateUserExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new UserApi();
            var userId = userId_example;  // String | The ID of the Kowabunga user. (default to null)
            var user = new User(); // User | 

            try {
                User result = apiInstance.updateUser(userId, user);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserApi.updateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserApi();
$userId = userId_example; // String | The ID of the Kowabunga user.
$user = ; // User | 

try {
    $result = $api_instance->updateUser($userId, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserApi->new();
my $userId = userId_example; # String | The ID of the Kowabunga user.
my $user = WWW::OPenAPIClient::Object::User->new(); # User | 

eval {
    my $result = $api_instance->updateUser(userId => $userId, user => $user);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserApi->updateUser: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.UserApi()
userId = userId_example # String | The ID of the Kowabunga user. (default to null)
user =  # User | 

try:
    api_response = api_instance.update_user(userId, user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserApi->updateUser: %s\n" % e)
extern crate UserApi;

pub fn main() {
    let userId = userId_example; // String
    let user = ; // User

    let mut context = UserApi::Context::default();
    let result = client.updateUser(userId, user, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
userId*
String
The ID of the Kowabunga user.
Required
Body parameters
Name Description
user *

User payload.

Responses


Vnet

createSubnet

Creates a new network subnet.


/vnet/{vnetId}/subnet

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/vnet/{vnetId}/subnet" \
 -d '{
  "extra_routes" : [ "extra_routes", "extra_routes" ],
  "application" : "user",
  "reserved" : [ {
    "last" : "last",
    "first" : "first"
  }, {
    "last" : "last",
    "first" : "first"
  } ],
  "name" : "name",
  "dns" : "dns",
  "description" : "description",
  "cidr" : "cidr",
  "gw_pool" : [ {
    "last" : "last",
    "first" : "first"
  }, {
    "last" : "last",
    "first" : "first"
  } ],
  "id" : "id",
  "gateway" : "gateway"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        Subnet subnet = ; // Subnet | 

        try {
            Subnet result = apiInstance.createSubnet(vnetId, subnet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#createSubnet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.
final Subnet subnet = new Subnet(); // Subnet | 

try {
    final result = await api_instance.createSubnet(vnetId, subnet);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createSubnet: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        Subnet subnet = ; // Subnet | 

        try {
            Subnet result = apiInstance.createSubnet(vnetId, subnet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#createSubnet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)
Subnet *subnet = ; // 

[apiInstance createSubnetWith:vnetId
    subnet:subnet
              completionHandler: ^(Subnet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.
var subnet = ; // {Subnet} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSubnet(vnetId, subnet, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createSubnetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)
            var subnet = new Subnet(); // Subnet | 

            try {
                Subnet result = apiInstance.createSubnet(vnetId, subnet);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.createSubnet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.
$subnet = ; // Subnet | 

try {
    $result = $api_instance->createSubnet($vnetId, $subnet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->createSubnet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.
my $subnet = WWW::OPenAPIClient::Object::Subnet->new(); # Subnet | 

eval {
    my $result = $api_instance->createSubnet(vnetId => $vnetId, subnet => $subnet);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VnetApi->createSubnet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)
subnet =  # Subnet | 

try:
    api_response = api_instance.create_subnet(vnetId, subnet)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VnetApi->createSubnet: %s\n" % e)
extern crate VnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String
    let subnet = ; // Subnet

    let mut context = VnetApi::Context::default();
    let result = client.createSubnet(vnetId, subnet, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required
Body parameters
Name Description
subnet *

Subnet payload.

Responses


createVNet

Creates a new virtual network.


/region/{regionId}/vnet

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/vnet" \
 -d '{
  "private" : true,
  "vlan" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "interface" : "interface"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();
        String regionId = regionId_example; // String | The ID of the region.
        VNet vNet = ; // VNet | 

        try {
            VNet result = apiInstance.createVNet(regionId, vNet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#createVNet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final VNet vNet = new VNet(); // VNet | 

try {
    final result = await api_instance.createVNet(regionId, vNet);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createVNet: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();
        String regionId = regionId_example; // String | The ID of the region.
        VNet vNet = ; // VNet | 

        try {
            VNet result = apiInstance.createVNet(regionId, vNet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#createVNet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
VNet *vNet = ; // 

[apiInstance createVNetWith:regionId
    vNet:vNet
              completionHandler: ^(VNet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var regionId = regionId_example; // {String} The ID of the region.
var vNet = ; // {VNet} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createVNet(regionId, vNet, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createVNetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var vNet = new VNet(); // VNet | 

            try {
                VNet result = apiInstance.createVNet(regionId, vNet);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.createVNet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();
$regionId = regionId_example; // String | The ID of the region.
$vNet = ; // VNet | 

try {
    $result = $api_instance->createVNet($regionId, $vNet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->createVNet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $vNet = WWW::OPenAPIClient::Object::VNet->new(); # VNet | 

eval {
    my $result = $api_instance->createVNet(regionId => $regionId, vNet => $vNet);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VnetApi->createVNet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()
regionId = regionId_example # String | The ID of the region. (default to null)
vNet =  # VNet | 

try:
    api_response = api_instance.create_v_net(regionId, vNet)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VnetApi->createVNet: %s\n" % e)
extern crate VnetApi;

pub fn main() {
    let regionId = regionId_example; // String
    let vNet = ; // VNet

    let mut context = VnetApi::Context::default();
    let result = client.createVNet(regionId, vNet, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
vNet *

VNet payload.

Responses


deleteVNet

Deletes an existing virtual network.


/vnet/{vnetId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/vnet/{vnetId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.

        try {
            apiInstance.deleteVNet(vnetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#deleteVNet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.

try {
    final result = await api_instance.deleteVNet(vnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteVNet: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.

        try {
            apiInstance.deleteVNet(vnetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#deleteVNet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)

[apiInstance deleteVNetWith:vnetId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteVNet(vnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteVNetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)

            try {
                apiInstance.deleteVNet(vnetId);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.deleteVNet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.

try {
    $api_instance->deleteVNet($vnetId);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->deleteVNet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.

eval {
    $api_instance->deleteVNet(vnetId => $vnetId);
};
if ($@) {
    warn "Exception when calling VnetApi->deleteVNet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)

try:
    api_instance.delete_v_net(vnetId)
except ApiException as e:
    print("Exception when calling VnetApi->deleteVNet: %s\n" % e)
extern crate VnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String

    let mut context = VnetApi::Context::default();
    let result = client.deleteVNet(vnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required

Responses


listRegionVNets

Returns the IDs of virtual network objects.


/region/{regionId}/vnets

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/vnets"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionVNets(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#listRegionVNets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listRegionVNets(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionVNets: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionVNets(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#listRegionVNets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listRegionVNetsWith:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionVNets(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionVNetsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listRegionVNets(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.listRegionVNets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listRegionVNets($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->listRegionVNets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listRegionVNets(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VnetApi->listRegionVNets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_region_v_nets(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VnetApi->listRegionVNets: %s\n" % e)
extern crate VnetApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = VnetApi::Context::default();
    let result = client.listRegionVNets(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


listVNetSubnets

Returns the IDs of network subnet objects.


/vnet/{vnetId}/subnets

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/vnet/{vnetId}/subnets"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.

        try {
            array['String'] result = apiInstance.listVNetSubnets(vnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#listVNetSubnets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.

try {
    final result = await api_instance.listVNetSubnets(vnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listVNetSubnets: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.

        try {
            array['String'] result = apiInstance.listVNetSubnets(vnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#listVNetSubnets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)

[apiInstance listVNetSubnetsWith:vnetId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listVNetSubnets(vnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listVNetSubnetsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)

            try {
                array['String'] result = apiInstance.listVNetSubnets(vnetId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.listVNetSubnets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.

try {
    $result = $api_instance->listVNetSubnets($vnetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->listVNetSubnets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.

eval {
    my $result = $api_instance->listVNetSubnets(vnetId => $vnetId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VnetApi->listVNetSubnets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)

try:
    api_response = api_instance.list_v_net_subnets(vnetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VnetApi->listVNetSubnets: %s\n" % e)
extern crate VnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String

    let mut context = VnetApi::Context::default();
    let result = client.listVNetSubnets(vnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required

Responses


listVNets

Returns the IDs of virtual network objects.


/vnet

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/vnet"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();

        try {
            array['String'] result = apiInstance.listVNets();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#listVNets");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listVNets();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listVNets: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();

        try {
            array['String'] result = apiInstance.listVNets();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#listVNets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];

[apiInstance listVNetsWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listVNets(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listVNetsExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();

            try {
                array['String'] result = apiInstance.listVNets();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.listVNets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();

try {
    $result = $api_instance->listVNets();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->listVNets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();

eval {
    my $result = $api_instance->listVNets();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VnetApi->listVNets: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()

try:
    api_response = api_instance.list_v_nets()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VnetApi->listVNets: %s\n" % e)
extern crate VnetApi;

pub fn main() {

    let mut context = VnetApi::Context::default();
    let result = client.listVNets(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readVNet

Returns a virtual network.


/vnet/{vnetId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/vnet/{vnetId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.

        try {
            VNet result = apiInstance.readVNet(vnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#readVNet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.

try {
    final result = await api_instance.readVNet(vnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readVNet: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.

        try {
            VNet result = apiInstance.readVNet(vnetId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#readVNet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)

[apiInstance readVNetWith:vnetId
              completionHandler: ^(VNet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readVNet(vnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readVNetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)

            try {
                VNet result = apiInstance.readVNet(vnetId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.readVNet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.

try {
    $result = $api_instance->readVNet($vnetId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->readVNet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.

eval {
    my $result = $api_instance->readVNet(vnetId => $vnetId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VnetApi->readVNet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)

try:
    api_response = api_instance.read_v_net(vnetId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VnetApi->readVNet: %s\n" % e)
extern crate VnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String

    let mut context = VnetApi::Context::default();
    let result = client.readVNet(vnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required

Responses


setVNetDefaultSubnet

Performs a virtual network setting of default network subnet.


/vnet/{vnetId}/subnet/{subnetId}/default

Usage and SDK Samples

curl -X PATCH \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/vnet/{vnetId}/subnet/{subnetId}/default"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            apiInstance.setVNetDefaultSubnet(vnetId, subnetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#setVNetDefaultSubnet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.
final String subnetId = new String(); // String | The ID of the network subnet.

try {
    final result = await api_instance.setVNetDefaultSubnet(vnetId, subnetId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setVNetDefaultSubnet: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        String subnetId = subnetId_example; // String | The ID of the network subnet.

        try {
            apiInstance.setVNetDefaultSubnet(vnetId, subnetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#setVNetDefaultSubnet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)
String *subnetId = subnetId_example; // The ID of the network subnet. (default to null)

[apiInstance setVNetDefaultSubnetWith:vnetId
    subnetId:subnetId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.
var subnetId = subnetId_example; // {String} The ID of the network subnet.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.setVNetDefaultSubnet(vnetId, subnetId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class setVNetDefaultSubnetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)
            var subnetId = subnetId_example;  // String | The ID of the network subnet. (default to null)

            try {
                apiInstance.setVNetDefaultSubnet(vnetId, subnetId);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.setVNetDefaultSubnet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.
$subnetId = subnetId_example; // String | The ID of the network subnet.

try {
    $api_instance->setVNetDefaultSubnet($vnetId, $subnetId);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->setVNetDefaultSubnet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.
my $subnetId = subnetId_example; # String | The ID of the network subnet.

eval {
    $api_instance->setVNetDefaultSubnet(vnetId => $vnetId, subnetId => $subnetId);
};
if ($@) {
    warn "Exception when calling VnetApi->setVNetDefaultSubnet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)
subnetId = subnetId_example # String | The ID of the network subnet. (default to null)

try:
    api_instance.set_v_net_default_subnet(vnetId, subnetId)
except ApiException as e:
    print("Exception when calling VnetApi->setVNetDefaultSubnet: %s\n" % e)
extern crate VnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String
    let subnetId = subnetId_example; // String

    let mut context = VnetApi::Context::default();
    let result = client.setVNetDefaultSubnet(vnetId, subnetId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required
subnetId*
String
The ID of the network subnet.
Required

Responses


updateVNet

Updates a virtual network configuration.


/vnet/{vnetId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/vnet/{vnetId}" \
 -d '{
  "private" : true,
  "vlan" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "interface" : "interface"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VnetApi;

import java.io.File;
import java.util.*;

public class VnetApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        VNet vNet = ; // VNet | 

        try {
            VNet result = apiInstance.updateVNet(vnetId, vNet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#updateVNet");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String vnetId = new String(); // String | The ID of the virtual network.
final VNet vNet = new VNet(); // VNet | 

try {
    final result = await api_instance.updateVNet(vnetId, vNet);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateVNet: $e\n');
}

import org.openapitools.client.api.VnetApi;

public class VnetApiExample {
    public static void main(String[] args) {
        VnetApi apiInstance = new VnetApi();
        String vnetId = vnetId_example; // String | The ID of the virtual network.
        VNet vNet = ; // VNet | 

        try {
            VNet result = apiInstance.updateVNet(vnetId, vNet);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VnetApi#updateVNet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VnetApi *apiInstance = [[VnetApi alloc] init];
String *vnetId = vnetId_example; // The ID of the virtual network. (default to null)
VNet *vNet = ; // 

[apiInstance updateVNetWith:vnetId
    vNet:vNet
              completionHandler: ^(VNet output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VnetApi()
var vnetId = vnetId_example; // {String} The ID of the virtual network.
var vNet = ; // {VNet} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateVNet(vnetId, vNet, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateVNetExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VnetApi();
            var vnetId = vnetId_example;  // String | The ID of the virtual network. (default to null)
            var vNet = new VNet(); // VNet | 

            try {
                VNet result = apiInstance.updateVNet(vnetId, vNet);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VnetApi.updateVNet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VnetApi();
$vnetId = vnetId_example; // String | The ID of the virtual network.
$vNet = ; // VNet | 

try {
    $result = $api_instance->updateVNet($vnetId, $vNet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VnetApi->updateVNet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VnetApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VnetApi->new();
my $vnetId = vnetId_example; # String | The ID of the virtual network.
my $vNet = WWW::OPenAPIClient::Object::VNet->new(); # VNet | 

eval {
    my $result = $api_instance->updateVNet(vnetId => $vnetId, vNet => $vNet);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VnetApi->updateVNet: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VnetApi()
vnetId = vnetId_example # String | The ID of the virtual network. (default to null)
vNet =  # VNet | 

try:
    api_response = api_instance.update_v_net(vnetId, vNet)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VnetApi->updateVNet: %s\n" % e)
extern crate VnetApi;

pub fn main() {
    let vnetId = vnetId_example; // String
    let vNet = ; // VNet

    let mut context = VnetApi::Context::default();
    let result = client.updateVNet(vnetId, vNet, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
vnetId*
String
The ID of the virtual network.
Required
Body parameters
Name Description
vNet *

VNet payload.

Responses


Volume

createProjectRegionVolume

Creates a new storage volume.


/project/{projectId}/region/{regionId}/volume

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/volume?poolId=poolId_example&templateId=templateId_example" \
 -d '{
  "size" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "type" : "os"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VolumeApi;

import java.io.File;
import java.util.*;

public class VolumeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VolumeApi apiInstance = new VolumeApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Volume volume = ; // Volume | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

        try {
            Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#createProjectRegionVolume");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.
final Volume volume = new Volume(); // Volume | 
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).
final String templateId = new String(); // String | Template to clone the storage volume from (optional, region's default if unspecified).

try {
    final result = await api_instance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectRegionVolume: $e\n');
}

import org.openapitools.client.api.VolumeApi;

public class VolumeApiExample {
    public static void main(String[] args) {
        VolumeApi apiInstance = new VolumeApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.
        Volume volume = ; // Volume | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

        try {
            Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#createProjectRegionVolume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VolumeApi *apiInstance = [[VolumeApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)
Volume *volume = ; // 
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
String *templateId = templateId_example; // Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)

[apiInstance createProjectRegionVolumeWith:projectId
    regionId:regionId
    volume:volume
    poolId:poolId
    templateId:templateId
              completionHandler: ^(Volume output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VolumeApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.
var volume = ; // {Volume} 
var opts = {
  'poolId': poolId_example, // {String} Storage pool ID (optional, region's default if unspecified).
  'templateId': templateId_example // {String} Template to clone the storage volume from (optional, region's default if unspecified).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectRegionVolume(projectId, regionId, volume, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectRegionVolumeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VolumeApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var volume = new Volume(); // Volume | 
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)
            var templateId = templateId_example;  // String | Template to clone the storage volume from (optional, region's default if unspecified). (optional)  (default to null)

            try {
                Volume result = apiInstance.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VolumeApi.createProjectRegionVolume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VolumeApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.
$volume = ; // Volume | 
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
$templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).

try {
    $result = $api_instance->createProjectRegionVolume($projectId, $regionId, $volume, $poolId, $templateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VolumeApi->createProjectRegionVolume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VolumeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VolumeApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.
my $volume = WWW::OPenAPIClient::Object::Volume->new(); # Volume | 
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).
my $templateId = templateId_example; # String | Template to clone the storage volume from (optional, region's default if unspecified).

eval {
    my $result = $api_instance->createProjectRegionVolume(projectId => $projectId, regionId => $regionId, volume => $volume, poolId => $poolId, templateId => $templateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VolumeApi->createProjectRegionVolume: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VolumeApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)
volume =  # Volume | 
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
templateId = templateId_example # String | Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)

try:
    api_response = api_instance.create_project_region_volume(projectId, regionId, volume, poolId=poolId, templateId=templateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VolumeApi->createProjectRegionVolume: %s\n" % e)
extern crate VolumeApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String
    let volume = ; // Volume
    let poolId = poolId_example; // String
    let templateId = templateId_example; // String

    let mut context = VolumeApi::Context::default();
    let result = client.createProjectRegionVolume(projectId, regionId, volume, poolId, templateId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
volume *

Volume payload.

Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).
templateId
String
Template to clone the storage volume from (optional, region's default if unspecified).

Responses


deleteVolume

Deletes an existing storage volume.


/volume/{volumeId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/volume/{volumeId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VolumeApi;

import java.io.File;
import java.util.*;

public class VolumeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VolumeApi apiInstance = new VolumeApi();
        String volumeId = volumeId_example; // String | The ID of the storage volume.

        try {
            apiInstance.deleteVolume(volumeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#deleteVolume");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String volumeId = new String(); // String | The ID of the storage volume.

try {
    final result = await api_instance.deleteVolume(volumeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteVolume: $e\n');
}

import org.openapitools.client.api.VolumeApi;

public class VolumeApiExample {
    public static void main(String[] args) {
        VolumeApi apiInstance = new VolumeApi();
        String volumeId = volumeId_example; // String | The ID of the storage volume.

        try {
            apiInstance.deleteVolume(volumeId);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#deleteVolume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VolumeApi *apiInstance = [[VolumeApi alloc] init];
String *volumeId = volumeId_example; // The ID of the storage volume. (default to null)

[apiInstance deleteVolumeWith:volumeId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VolumeApi()
var volumeId = volumeId_example; // {String} The ID of the storage volume.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteVolume(volumeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteVolumeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VolumeApi();
            var volumeId = volumeId_example;  // String | The ID of the storage volume. (default to null)

            try {
                apiInstance.deleteVolume(volumeId);
            } catch (Exception e) {
                Debug.Print("Exception when calling VolumeApi.deleteVolume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VolumeApi();
$volumeId = volumeId_example; // String | The ID of the storage volume.

try {
    $api_instance->deleteVolume($volumeId);
} catch (Exception $e) {
    echo 'Exception when calling VolumeApi->deleteVolume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VolumeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VolumeApi->new();
my $volumeId = volumeId_example; # String | The ID of the storage volume.

eval {
    $api_instance->deleteVolume(volumeId => $volumeId);
};
if ($@) {
    warn "Exception when calling VolumeApi->deleteVolume: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VolumeApi()
volumeId = volumeId_example # String | The ID of the storage volume. (default to null)

try:
    api_instance.delete_volume(volumeId)
except ApiException as e:
    print("Exception when calling VolumeApi->deleteVolume: %s\n" % e)
extern crate VolumeApi;

pub fn main() {
    let volumeId = volumeId_example; // String

    let mut context = VolumeApi::Context::default();
    let result = client.deleteVolume(volumeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
volumeId*
String
The ID of the storage volume.
Required

Responses


listProjectRegionVolumes

Returns the IDs of storage volume objects.


/project/{projectId}/region/{regionId}/volumes

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/region/{regionId}/volumes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VolumeApi;

import java.io.File;
import java.util.*;

public class VolumeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VolumeApi apiInstance = new VolumeApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#listProjectRegionVolumes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listProjectRegionVolumes(projectId, regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectRegionVolumes: $e\n');
}

import org.openapitools.client.api.VolumeApi;

public class VolumeApiExample {
    public static void main(String[] args) {
        VolumeApi apiInstance = new VolumeApi();
        String projectId = projectId_example; // String | The ID of the project.
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#listProjectRegionVolumes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VolumeApi *apiInstance = [[VolumeApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listProjectRegionVolumesWith:projectId
    regionId:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VolumeApi()
var projectId = projectId_example; // {String} The ID of the project.
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectRegionVolumes(projectId, regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectRegionVolumesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VolumeApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listProjectRegionVolumes(projectId, regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VolumeApi.listProjectRegionVolumes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VolumeApi();
$projectId = projectId_example; // String | The ID of the project.
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listProjectRegionVolumes($projectId, $regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VolumeApi->listProjectRegionVolumes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VolumeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VolumeApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listProjectRegionVolumes(projectId => $projectId, regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VolumeApi->listProjectRegionVolumes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VolumeApi()
projectId = projectId_example # String | The ID of the project. (default to null)
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_project_region_volumes(projectId, regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VolumeApi->listProjectRegionVolumes: %s\n" % e)
extern crate VolumeApi;

pub fn main() {
    let projectId = projectId_example; // String
    let regionId = regionId_example; // String

    let mut context = VolumeApi::Context::default();
    let result = client.listProjectRegionVolumes(projectId, regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
regionId*
String
The ID of the region.
Required

Responses


listStoragePoolVolumes

Returns the IDs of storage volume objects.


/pool/{poolId}/volumes

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/pool/{poolId}/volumes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VolumeApi;

import java.io.File;
import java.util.*;

public class VolumeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VolumeApi apiInstance = new VolumeApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            array['String'] result = apiInstance.listStoragePoolVolumes(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#listStoragePoolVolumes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String poolId = new String(); // String | The ID of the storage pool.

try {
    final result = await api_instance.listStoragePoolVolumes(poolId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listStoragePoolVolumes: $e\n');
}

import org.openapitools.client.api.VolumeApi;

public class VolumeApiExample {
    public static void main(String[] args) {
        VolumeApi apiInstance = new VolumeApi();
        String poolId = poolId_example; // String | The ID of the storage pool.

        try {
            array['String'] result = apiInstance.listStoragePoolVolumes(poolId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#listStoragePoolVolumes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VolumeApi *apiInstance = [[VolumeApi alloc] init];
String *poolId = poolId_example; // The ID of the storage pool. (default to null)

[apiInstance listStoragePoolVolumesWith:poolId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VolumeApi()
var poolId = poolId_example; // {String} The ID of the storage pool.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listStoragePoolVolumes(poolId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listStoragePoolVolumesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VolumeApi();
            var poolId = poolId_example;  // String | The ID of the storage pool. (default to null)

            try {
                array['String'] result = apiInstance.listStoragePoolVolumes(poolId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VolumeApi.listStoragePoolVolumes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VolumeApi();
$poolId = poolId_example; // String | The ID of the storage pool.

try {
    $result = $api_instance->listStoragePoolVolumes($poolId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VolumeApi->listStoragePoolVolumes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VolumeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VolumeApi->new();
my $poolId = poolId_example; # String | The ID of the storage pool.

eval {
    my $result = $api_instance->listStoragePoolVolumes(poolId => $poolId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VolumeApi->listStoragePoolVolumes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VolumeApi()
poolId = poolId_example # String | The ID of the storage pool. (default to null)

try:
    api_response = api_instance.list_storage_pool_volumes(poolId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VolumeApi->listStoragePoolVolumes: %s\n" % e)
extern crate VolumeApi;

pub fn main() {
    let poolId = poolId_example; // String

    let mut context = VolumeApi::Context::default();
    let result = client.listStoragePoolVolumes(poolId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
poolId*
String
The ID of the storage pool.
Required

Responses


listVolumes

Returns the IDs of storage volume objects.


/volume

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/volume"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VolumeApi;

import java.io.File;
import java.util.*;

public class VolumeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VolumeApi apiInstance = new VolumeApi();

        try {
            array['String'] result = apiInstance.listVolumes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#listVolumes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listVolumes();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listVolumes: $e\n');
}

import org.openapitools.client.api.VolumeApi;

public class VolumeApiExample {
    public static void main(String[] args) {
        VolumeApi apiInstance = new VolumeApi();

        try {
            array['String'] result = apiInstance.listVolumes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#listVolumes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VolumeApi *apiInstance = [[VolumeApi alloc] init];

[apiInstance listVolumesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VolumeApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listVolumes(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listVolumesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VolumeApi();

            try {
                array['String'] result = apiInstance.listVolumes();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VolumeApi.listVolumes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VolumeApi();

try {
    $result = $api_instance->listVolumes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VolumeApi->listVolumes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VolumeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VolumeApi->new();

eval {
    my $result = $api_instance->listVolumes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VolumeApi->listVolumes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VolumeApi()

try:
    api_response = api_instance.list_volumes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VolumeApi->listVolumes: %s\n" % e)
extern crate VolumeApi;

pub fn main() {

    let mut context = VolumeApi::Context::default();
    let result = client.listVolumes(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readVolume

Returns a storage volume.


/volume/{volumeId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/volume/{volumeId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VolumeApi;

import java.io.File;
import java.util.*;

public class VolumeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VolumeApi apiInstance = new VolumeApi();
        String volumeId = volumeId_example; // String | The ID of the storage volume.

        try {
            Volume result = apiInstance.readVolume(volumeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#readVolume");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String volumeId = new String(); // String | The ID of the storage volume.

try {
    final result = await api_instance.readVolume(volumeId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readVolume: $e\n');
}

import org.openapitools.client.api.VolumeApi;

public class VolumeApiExample {
    public static void main(String[] args) {
        VolumeApi apiInstance = new VolumeApi();
        String volumeId = volumeId_example; // String | The ID of the storage volume.

        try {
            Volume result = apiInstance.readVolume(volumeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#readVolume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VolumeApi *apiInstance = [[VolumeApi alloc] init];
String *volumeId = volumeId_example; // The ID of the storage volume. (default to null)

[apiInstance readVolumeWith:volumeId
              completionHandler: ^(Volume output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VolumeApi()
var volumeId = volumeId_example; // {String} The ID of the storage volume.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readVolume(volumeId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readVolumeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VolumeApi();
            var volumeId = volumeId_example;  // String | The ID of the storage volume. (default to null)

            try {
                Volume result = apiInstance.readVolume(volumeId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VolumeApi.readVolume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VolumeApi();
$volumeId = volumeId_example; // String | The ID of the storage volume.

try {
    $result = $api_instance->readVolume($volumeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VolumeApi->readVolume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VolumeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VolumeApi->new();
my $volumeId = volumeId_example; # String | The ID of the storage volume.

eval {
    my $result = $api_instance->readVolume(volumeId => $volumeId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VolumeApi->readVolume: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VolumeApi()
volumeId = volumeId_example # String | The ID of the storage volume. (default to null)

try:
    api_response = api_instance.read_volume(volumeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VolumeApi->readVolume: %s\n" % e)
extern crate VolumeApi;

pub fn main() {
    let volumeId = volumeId_example; // String

    let mut context = VolumeApi::Context::default();
    let result = client.readVolume(volumeId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
volumeId*
String
The ID of the storage volume.
Required

Responses


updateVolume

Updates a storage volume configuration.


/volume/{volumeId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/volume/{volumeId}" \
 -d '{
  "size" : 0,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "type" : "os"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VolumeApi;

import java.io.File;
import java.util.*;

public class VolumeApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        VolumeApi apiInstance = new VolumeApi();
        String volumeId = volumeId_example; // String | The ID of the storage volume.
        Volume volume = ; // Volume | 

        try {
            Volume result = apiInstance.updateVolume(volumeId, volume);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#updateVolume");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String volumeId = new String(); // String | The ID of the storage volume.
final Volume volume = new Volume(); // Volume | 

try {
    final result = await api_instance.updateVolume(volumeId, volume);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateVolume: $e\n');
}

import org.openapitools.client.api.VolumeApi;

public class VolumeApiExample {
    public static void main(String[] args) {
        VolumeApi apiInstance = new VolumeApi();
        String volumeId = volumeId_example; // String | The ID of the storage volume.
        Volume volume = ; // Volume | 

        try {
            Volume result = apiInstance.updateVolume(volumeId, volume);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VolumeApi#updateVolume");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
VolumeApi *apiInstance = [[VolumeApi alloc] init];
String *volumeId = volumeId_example; // The ID of the storage volume. (default to null)
Volume *volume = ; // 

[apiInstance updateVolumeWith:volumeId
    volume:volume
              completionHandler: ^(Volume output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.VolumeApi()
var volumeId = volumeId_example; // {String} The ID of the storage volume.
var volume = ; // {Volume} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateVolume(volumeId, volume, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateVolumeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new VolumeApi();
            var volumeId = volumeId_example;  // String | The ID of the storage volume. (default to null)
            var volume = new Volume(); // Volume | 

            try {
                Volume result = apiInstance.updateVolume(volumeId, volume);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VolumeApi.updateVolume: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VolumeApi();
$volumeId = volumeId_example; // String | The ID of the storage volume.
$volume = ; // Volume | 

try {
    $result = $api_instance->updateVolume($volumeId, $volume);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VolumeApi->updateVolume: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VolumeApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VolumeApi->new();
my $volumeId = volumeId_example; # String | The ID of the storage volume.
my $volume = WWW::OPenAPIClient::Object::Volume->new(); # Volume | 

eval {
    my $result = $api_instance->updateVolume(volumeId => $volumeId, volume => $volume);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VolumeApi->updateVolume: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.VolumeApi()
volumeId = volumeId_example # String | The ID of the storage volume. (default to null)
volume =  # Volume | 

try:
    api_response = api_instance.update_volume(volumeId, volume)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VolumeApi->updateVolume: %s\n" % e)
extern crate VolumeApi;

pub fn main() {
    let volumeId = volumeId_example; // String
    let volume = ; // Volume

    let mut context = VolumeApi::Context::default();
    let result = client.updateVolume(volumeId, volume, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
volumeId*
String
The ID of the storage volume.
Required
Body parameters
Name Description
volume *

Volume payload.

Responses


Zone

createKaktus

Creates a new Kaktus computing node.


/zone/{zoneId}/kaktus

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/zone/{zoneId}/kaktus" \
 -d '{
  "memory_cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "name" : "name",
  "description" : "description",
  "overcommit_memory_ratio" : 1,
  "cpu_cost" : {
    "price" : 0.8008282,
    "currency" : "currency"
  },
  "id" : "id",
  "overcommit_cpu_ratio" : 6,
  "agents" : [ "agents", "agents" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kaktus kaktus = ; // Kaktus | 

        try {
            Kaktus result = apiInstance.createKaktus(zoneId, kaktus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createKaktus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String zoneId = new String(); // String | The ID of the availability zone.
final Kaktus kaktus = new Kaktus(); // Kaktus | 

try {
    final result = await api_instance.createKaktus(zoneId, kaktus);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createKaktus: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kaktus kaktus = ; // Kaktus | 

        try {
            Kaktus result = apiInstance.createKaktus(zoneId, kaktus);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createKaktus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Kaktus *kaktus = ; // 

[apiInstance createKaktusWith:zoneId
    kaktus:kaktus
              completionHandler: ^(Kaktus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var kaktus = ; // {Kaktus} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createKaktus(zoneId, kaktus, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createKaktusExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var kaktus = new Kaktus(); // Kaktus | 

            try {
                Kaktus result = apiInstance.createKaktus(zoneId, kaktus);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.createKaktus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$zoneId = zoneId_example; // String | The ID of the availability zone.
$kaktus = ; // Kaktus | 

try {
    $result = $api_instance->createKaktus($zoneId, $kaktus);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->createKaktus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $kaktus = WWW::OPenAPIClient::Object::Kaktus->new(); # Kaktus | 

eval {
    my $result = $api_instance->createKaktus(zoneId => $zoneId, kaktus => $kaktus);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->createKaktus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
kaktus =  # Kaktus | 

try:
    api_response = api_instance.create_kaktus(zoneId, kaktus)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->createKaktus: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let zoneId = zoneId_example; // String
    let kaktus = ; // Kaktus

    let mut context = ZoneApi::Context::default();
    let result = client.createKaktus(zoneId, kaktus, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
kaktus *

Kaktus payload.

Responses


createProjectZoneInstance

Creates a new virtual machine instance.


/project/{projectId}/zone/{zoneId}/instance

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/instance" \
 -d '{
  "memory" : 0,
  "adapters" : [ "adapters", "adapters" ],
  "name" : "name",
  "volumes" : [ "volumes", "volumes" ],
  "description" : "description",
  "id" : "id",
  "vcpus" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Instance instance = ; // Instance | 

        try {
            Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createProjectZoneInstance");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Instance instance = new Instance(); // Instance | 

try {
    final result = await api_instance.createProjectZoneInstance(projectId, zoneId, instance);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneInstance: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Instance instance = ; // Instance | 

        try {
            Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createProjectZoneInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Instance *instance = ; // 

[apiInstance createProjectZoneInstanceWith:projectId
    zoneId:zoneId
    instance:instance
              completionHandler: ^(Instance output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var instance = ; // {Instance} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneInstance(projectId, zoneId, instance, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneInstanceExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var instance = new Instance(); // Instance | 

            try {
                Instance result = apiInstance.createProjectZoneInstance(projectId, zoneId, instance);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.createProjectZoneInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$instance = ; // Instance | 

try {
    $result = $api_instance->createProjectZoneInstance($projectId, $zoneId, $instance);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->createProjectZoneInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $instance = WWW::OPenAPIClient::Object::Instance->new(); # Instance | 

eval {
    my $result = $api_instance->createProjectZoneInstance(projectId => $projectId, zoneId => $zoneId, instance => $instance);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->createProjectZoneInstance: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
instance =  # Instance | 

try:
    api_response = api_instance.create_project_zone_instance(projectId, zoneId, instance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->createProjectZoneInstance: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let instance = ; // Instance

    let mut context = ZoneApi::Context::default();
    let result = client.createProjectZoneInstance(projectId, zoneId, instance, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
instance *

Instance payload.

Responses


createProjectZoneKompute

Creates a new Kompute.


/project/{projectId}/zone/{zoneId}/kompute

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/kompute?poolId=poolId_example&templateId=templateId_example&public=true" \
 -d '{
  "disk" : 1,
  "data_disk" : 5,
  "memory" : 0,
  "ip" : "ip",
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vcpus" : 6
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kompute kompute = ; // Kompute | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
        Boolean public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

        try {
            Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createProjectZoneKompute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Kompute kompute = new Kompute(); // Kompute | 
final String poolId = new String(); // String | Storage pool ID (optional, region's default if unspecified).
final String templateId = new String(); // String | Template to clone the storage volume from (optional, region's default if unspecified).
final Boolean public = new Boolean(); // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

try {
    final result = await api_instance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneKompute: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Kompute kompute = ; // Kompute | 
        String poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
        String templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
        Boolean public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

        try {
            Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createProjectZoneKompute");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Kompute *kompute = ; // 
String *poolId = poolId_example; // Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
String *templateId = templateId_example; // Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)
Boolean *public = true; // Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional) (default to null)

[apiInstance createProjectZoneKomputeWith:projectId
    zoneId:zoneId
    kompute:kompute
    poolId:poolId
    templateId:templateId
    public:public
              completionHandler: ^(Kompute output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var kompute = ; // {Kompute} 
var opts = {
  'poolId': poolId_example, // {String} Storage pool ID (optional, region's default if unspecified).
  'templateId': templateId_example, // {String} Template to clone the storage volume from (optional, region's default if unspecified).
  'public': true // {Boolean} Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneKompute(projectId, zoneId, kompute, opts, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneKomputeExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var kompute = new Kompute(); // Kompute | 
            var poolId = poolId_example;  // String | Storage pool ID (optional, region's default if unspecified). (optional)  (default to null)
            var templateId = templateId_example;  // String | Template to clone the storage volume from (optional, region's default if unspecified). (optional)  (default to null)
            var public = true;  // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional)  (default to null)

            try {
                Kompute result = apiInstance.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.createProjectZoneKompute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$kompute = ; // Kompute | 
$poolId = poolId_example; // String | Storage pool ID (optional, region's default if unspecified).
$templateId = templateId_example; // String | Template to clone the storage volume from (optional, region's default if unspecified).
$public = true; // Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

try {
    $result = $api_instance->createProjectZoneKompute($projectId, $zoneId, $kompute, $poolId, $templateId, $public);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->createProjectZoneKompute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $kompute = WWW::OPenAPIClient::Object::Kompute->new(); # Kompute | 
my $poolId = poolId_example; # String | Storage pool ID (optional, region's default if unspecified).
my $templateId = templateId_example; # String | Template to clone the storage volume from (optional, region's default if unspecified).
my $public = true; # Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

eval {
    my $result = $api_instance->createProjectZoneKompute(projectId => $projectId, zoneId => $zoneId, kompute => $kompute, poolId => $poolId, templateId => $templateId, public => $public);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->createProjectZoneKompute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
kompute =  # Kompute | 
poolId = poolId_example # String | Storage pool ID (optional, region's default if unspecified). (optional) (default to null)
templateId = templateId_example # String | Template to clone the storage volume from (optional, region's default if unspecified). (optional) (default to null)
public = true # Boolean | Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false). (optional) (default to null)

try:
    api_response = api_instance.create_project_zone_kompute(projectId, zoneId, kompute, poolId=poolId, templateId=templateId, public=public)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->createProjectZoneKompute: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let kompute = ; // Kompute
    let poolId = poolId_example; // String
    let templateId = templateId_example; // String
    let public = true; // Boolean

    let mut context = ZoneApi::Context::default();
    let result = client.createProjectZoneKompute(projectId, zoneId, kompute, poolId, templateId, public, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
kompute *

Kompute payload.

Query parameters
Name Description
poolId
String
Storage pool ID (optional, region's default if unspecified).
templateId
String
Template to clone the storage volume from (optional, region's default if unspecified).
public
Boolean
Should Kompute be exposed over public Internet ? (a public IPv4 address will then be auto-assigned, default to false).

Responses


createProjectZoneKonvey

Creates a new Konvey (Kowabunga Network Load-Balancer).


/project/{projectId}/zone/{zoneId}/konvey

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/konvey" \
 -d '{
  "endpoints" : [ {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  }, {
    "protocol" : "tcp",
    "port" : 0,
    "name" : "name",
    "backends" : {
      "port" : 6,
      "hosts" : [ "hosts", "hosts" ]
    }
  } ],
  "failover" : true,
  "name" : "name",
  "description" : "description",
  "id" : "id",
  "vip" : "vip"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createProjectZoneKonvey");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.
final Konvey konvey = new Konvey(); // Konvey | 

try {
    final result = await api_instance.createProjectZoneKonvey(projectId, zoneId, konvey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createProjectZoneKonvey: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Konvey konvey = ; // Konvey | 

        try {
            Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createProjectZoneKonvey");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Konvey *konvey = ; // 

[apiInstance createProjectZoneKonveyWith:projectId
    zoneId:zoneId
    konvey:konvey
              completionHandler: ^(Konvey output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var konvey = ; // {Konvey} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProjectZoneKonvey(projectId, zoneId, konvey, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createProjectZoneKonveyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var konvey = new Konvey(); // Konvey | 

            try {
                Konvey result = apiInstance.createProjectZoneKonvey(projectId, zoneId, konvey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.createProjectZoneKonvey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.
$konvey = ; // Konvey | 

try {
    $result = $api_instance->createProjectZoneKonvey($projectId, $zoneId, $konvey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->createProjectZoneKonvey: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $konvey = WWW::OPenAPIClient::Object::Konvey->new(); # Konvey | 

eval {
    my $result = $api_instance->createProjectZoneKonvey(projectId => $projectId, zoneId => $zoneId, konvey => $konvey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->createProjectZoneKonvey: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
konvey =  # Konvey | 

try:
    api_response = api_instance.create_project_zone_konvey(projectId, zoneId, konvey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->createProjectZoneKonvey: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String
    let konvey = ; // Konvey

    let mut context = ZoneApi::Context::default();
    let result = client.createProjectZoneKonvey(projectId, zoneId, konvey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
konvey *

Konvey payload.

Responses


createZone

Creates a new availability zone.


/region/{regionId}/zone

Usage and SDK Samples

curl -X POST \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/region/{regionId}/zone" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String regionId = regionId_example; // String | The ID of the region.
        Zone zone = ; // Zone | 

        try {
            Zone result = apiInstance.createZone(regionId, zone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createZone");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.
final Zone zone = new Zone(); // Zone | 

try {
    final result = await api_instance.createZone(regionId, zone);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createZone: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String regionId = regionId_example; // String | The ID of the region.
        Zone zone = ; // Zone | 

        try {
            Zone result = apiInstance.createZone(regionId, zone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#createZone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)
Zone *zone = ; // 

[apiInstance createZoneWith:regionId
    zone:zone
              completionHandler: ^(Zone output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var regionId = regionId_example; // {String} The ID of the region.
var zone = ; // {Zone} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createZone(regionId, zone, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class createZoneExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)
            var zone = new Zone(); // Zone | 

            try {
                Zone result = apiInstance.createZone(regionId, zone);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.createZone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$regionId = regionId_example; // String | The ID of the region.
$zone = ; // Zone | 

try {
    $result = $api_instance->createZone($regionId, $zone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->createZone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $regionId = regionId_example; # String | The ID of the region.
my $zone = WWW::OPenAPIClient::Object::Zone->new(); # Zone | 

eval {
    my $result = $api_instance->createZone(regionId => $regionId, zone => $zone);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->createZone: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
regionId = regionId_example # String | The ID of the region. (default to null)
zone =  # Zone | 

try:
    api_response = api_instance.create_zone(regionId, zone)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->createZone: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let regionId = regionId_example; // String
    let zone = ; // Zone

    let mut context = ZoneApi::Context::default();
    let result = client.createZone(regionId, zone, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required
Body parameters
Name Description
zone *

Zone payload.

Responses


deleteZone

Deletes an existing availability zone.


/zone/{zoneId}

Usage and SDK Samples

curl -X DELETE \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/zone/{zoneId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            apiInstance.deleteZone(zoneId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#deleteZone");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.deleteZone(zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteZone: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            apiInstance.deleteZone(zoneId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#deleteZone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance deleteZoneWith:zoneId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteZone(zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class deleteZoneExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                apiInstance.deleteZone(zoneId);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.deleteZone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $api_instance->deleteZone($zoneId);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->deleteZone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    $api_instance->deleteZone(zoneId => $zoneId);
};
if ($@) {
    warn "Exception when calling ZoneApi->deleteZone: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_instance.delete_zone(zoneId)
except ApiException as e:
    print("Exception when calling ZoneApi->deleteZone: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let zoneId = zoneId_example; // String

    let mut context = ZoneApi::Context::default();
    let result = client.deleteZone(zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
zoneId*
String
The ID of the availability zone.
Required

Responses


listProjectZoneInstances

Returns the IDs of virtual machine instance objects.


/project/{projectId}/zone/{zoneId}/instances

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/instances"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listProjectZoneInstances");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneInstances(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneInstances: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listProjectZoneInstances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneInstancesWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneInstances(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneInstancesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneInstances(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.listProjectZoneInstances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneInstances($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->listProjectZoneInstances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneInstances(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->listProjectZoneInstances: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_instances(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->listProjectZoneInstances: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = ZoneApi::Context::default();
    let result = client.listProjectZoneInstances(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


listProjectZoneKomputes

Returns the IDs of Kompute objects.


/project/{projectId}/zone/{zoneId}/komputes

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/komputes"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listProjectZoneKomputes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneKomputes(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneKomputes: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listProjectZoneKomputes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneKomputesWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneKomputes(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneKomputesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneKomputes(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.listProjectZoneKomputes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneKomputes($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->listProjectZoneKomputes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneKomputes(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->listProjectZoneKomputes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_komputes(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->listProjectZoneKomputes: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = ZoneApi::Context::default();
    let result = client.listProjectZoneKomputes(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


listProjectZoneKonveys

Returns the IDs of Konvey (Kowabunga Network Load-Balancer) objects.


/project/{projectId}/zone/{zoneId}/konveys

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/project/{projectId}/zone/{zoneId}/konveys"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listProjectZoneKonveys");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String projectId = new String(); // String | The ID of the project.
final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listProjectZoneKonveys(projectId, zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listProjectZoneKonveys: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String projectId = projectId_example; // String | The ID of the project.
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listProjectZoneKonveys");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *projectId = projectId_example; // The ID of the project. (default to null)
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listProjectZoneKonveysWith:projectId
    zoneId:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var projectId = projectId_example; // {String} The ID of the project.
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectZoneKonveys(projectId, zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listProjectZoneKonveysExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var projectId = projectId_example;  // String | The ID of the project. (default to null)
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listProjectZoneKonveys(projectId, zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.listProjectZoneKonveys: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$projectId = projectId_example; // String | The ID of the project.
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listProjectZoneKonveys($projectId, $zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->listProjectZoneKonveys: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $projectId = projectId_example; # String | The ID of the project.
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listProjectZoneKonveys(projectId => $projectId, zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->listProjectZoneKonveys: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
projectId = projectId_example # String | The ID of the project. (default to null)
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_project_zone_konveys(projectId, zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->listProjectZoneKonveys: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let projectId = projectId_example; // String
    let zoneId = zoneId_example; // String

    let mut context = ZoneApi::Context::default();
    let result = client.listProjectZoneKonveys(projectId, zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
projectId*
String
The ID of the project.
Required
zoneId*
String
The ID of the availability zone.
Required

Responses


listRegionZones

Returns the IDs of availability zone objects.


/region/{regionId}/zones

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/region/{regionId}/zones"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionZones(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listRegionZones");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String regionId = new String(); // String | The ID of the region.

try {
    final result = await api_instance.listRegionZones(regionId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listRegionZones: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String regionId = regionId_example; // String | The ID of the region.

        try {
            array['String'] result = apiInstance.listRegionZones(regionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listRegionZones");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *regionId = regionId_example; // The ID of the region. (default to null)

[apiInstance listRegionZonesWith:regionId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var regionId = regionId_example; // {String} The ID of the region.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listRegionZones(regionId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listRegionZonesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var regionId = regionId_example;  // String | The ID of the region. (default to null)

            try {
                array['String'] result = apiInstance.listRegionZones(regionId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.listRegionZones: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$regionId = regionId_example; // String | The ID of the region.

try {
    $result = $api_instance->listRegionZones($regionId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->listRegionZones: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $regionId = regionId_example; # String | The ID of the region.

eval {
    my $result = $api_instance->listRegionZones(regionId => $regionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->listRegionZones: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
regionId = regionId_example # String | The ID of the region. (default to null)

try:
    api_response = api_instance.list_region_zones(regionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->listRegionZones: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let regionId = regionId_example; // String

    let mut context = ZoneApi::Context::default();
    let result = client.listRegionZones(regionId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
regionId*
String
The ID of the region.
Required

Responses


listZoneKaktuses

Returns the IDs of Kaktus computing node objects.


/zone/{zoneId}/kaktuses

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/zone/{zoneId}/kaktuses"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listZoneKaktuses(zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listZoneKaktuses");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.listZoneKaktuses(zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listZoneKaktuses: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            array['String'] result = apiInstance.listZoneKaktuses(zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listZoneKaktuses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance listZoneKaktusesWith:zoneId
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listZoneKaktuses(zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listZoneKaktusesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                array['String'] result = apiInstance.listZoneKaktuses(zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.listZoneKaktuses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->listZoneKaktuses($zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->listZoneKaktuses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->listZoneKaktuses(zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->listZoneKaktuses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.list_zone_kaktuses(zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->listZoneKaktuses: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let zoneId = zoneId_example; // String

    let mut context = ZoneApi::Context::default();
    let result = client.listZoneKaktuses(zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
zoneId*
String
The ID of the availability zone.
Required

Responses


listZones

Returns the IDs of availability zone objects.


/zone

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/zone"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();

        try {
            array['String'] result = apiInstance.listZones();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listZones");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.listZones();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->listZones: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();

        try {
            array['String'] result = apiInstance.listZones();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#listZones");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];

[apiInstance listZonesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listZones(callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class listZonesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();

            try {
                array['String'] result = apiInstance.listZones();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.listZones: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();

try {
    $result = $api_instance->listZones();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->listZones: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();

eval {
    my $result = $api_instance->listZones();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->listZones: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()

try:
    api_response = api_instance.list_zones()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->listZones: %s\n" % e)
extern crate ZoneApi;

pub fn main() {

    let mut context = ZoneApi::Context::default();
    let result = client.listZones(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


readZone

Returns a availability zone.


/zone/{zoneId}

Usage and SDK Samples

curl -X GET \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 "/api/v1/zone/{zoneId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            Zone result = apiInstance.readZone(zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#readZone");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String zoneId = new String(); // String | The ID of the availability zone.

try {
    final result = await api_instance.readZone(zoneId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->readZone: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.

        try {
            Zone result = apiInstance.readZone(zoneId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#readZone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)

[apiInstance readZoneWith:zoneId
              completionHandler: ^(Zone output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var zoneId = zoneId_example; // {String} The ID of the availability zone.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.readZone(zoneId, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class readZoneExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)

            try {
                Zone result = apiInstance.readZone(zoneId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.readZone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$zoneId = zoneId_example; // String | The ID of the availability zone.

try {
    $result = $api_instance->readZone($zoneId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->readZone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $zoneId = zoneId_example; # String | The ID of the availability zone.

eval {
    my $result = $api_instance->readZone(zoneId => $zoneId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->readZone: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)

try:
    api_response = api_instance.read_zone(zoneId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->readZone: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let zoneId = zoneId_example; // String

    let mut context = ZoneApi::Context::default();
    let result = client.readZone(zoneId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
zoneId*
String
The ID of the availability zone.
Required

Responses


updateZone

Updates a availability zone configuration.


/zone/{zoneId}

Usage and SDK Samples

curl -X PUT \
-H "X-API-Key: [[apiKey]]" \
 -H "Authorization: Bearer [[accessToken]]" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "/api/v1/zone/{zoneId}" \
 -d '{
  "name" : "name",
  "description" : "description",
  "id" : "id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ZoneApi;

import java.io.File;
import java.util.*;

public class ZoneApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");

        // Configure Bearer (JWT) access token for authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        // Create an instance of the API class
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Zone zone = ; // Zone | 

        try {
            Zone result = apiInstance.updateZone(zoneId, zone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#updateZone");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String zoneId = new String(); // String | The ID of the availability zone.
final Zone zone = new Zone(); // Zone | 

try {
    final result = await api_instance.updateZone(zoneId, zone);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateZone: $e\n');
}

import org.openapitools.client.api.ZoneApi;

public class ZoneApiExample {
    public static void main(String[] args) {
        ZoneApi apiInstance = new ZoneApi();
        String zoneId = zoneId_example; // String | The ID of the availability zone.
        Zone zone = ; // Zone | 

        try {
            Zone result = apiInstance.updateZone(zoneId, zone);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ZoneApi#updateZone");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-API-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-API-Key"];

// Configure Bearer (JWT) access token for authorization: BearerAuth
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
ZoneApi *apiInstance = [[ZoneApi alloc] init];
String *zoneId = zoneId_example; // The ID of the availability zone. (default to null)
Zone *zone = ; // 

[apiInstance updateZoneWith:zoneId
    zone:zone
              completionHandler: ^(Zone output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var KowabungaApiDocumentation = require('kowabunga_api_documentation');
var defaultClient = KowabungaApiDocumentation.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token";

// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new KowabungaApiDocumentation.ZoneApi()
var zoneId = zoneId_example; // {String} The ID of the availability zone.
var zone = ; // {Zone} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateZone(zoneId, zone, callback);
using System;
using System.Diagnostics;
using kowabunga.Api;
using kowabunga.Client;
using kowabunga.Model;

namespace Example
{
    public class updateZoneExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("X-API-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-API-Key", "Bearer");
            // Configure Bearer (JWT) access token for authorization: BearerAuth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new ZoneApi();
            var zoneId = zoneId_example;  // String | The ID of the availability zone. (default to null)
            var zone = new Zone(); // Zone | 

            try {
                Zone result = apiInstance.updateZone(zoneId, zone);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ZoneApi.updateZone: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

// Configure Bearer (JWT) access token for authorization: BearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ZoneApi();
$zoneId = zoneId_example; // String | The ID of the availability zone.
$zone = ; // Zone | 

try {
    $result = $api_instance->updateZone($zoneId, $zone);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneApi->updateZone: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ZoneApi;

# Configure API key authorization: ApiKeyAuth
$WWW::OPenAPIClient::Configuration::api_key->{'X-API-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-API-Key'} = "Bearer";

# Configure Bearer (JWT) access token for authorization: BearerAuth
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ZoneApi->new();
my $zoneId = zoneId_example; # String | The ID of the availability zone.
my $zone = WWW::OPenAPIClient::Object::Zone->new(); # Zone | 

eval {
    my $result = $api_instance->updateZone(zoneId => $zoneId, zone => $zone);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ZoneApi->updateZone: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
openapi_client.configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-API-Key'] = 'Bearer'

# Configure Bearer (JWT) access token for authorization: BearerAuth
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.ZoneApi()
zoneId = zoneId_example # String | The ID of the availability zone. (default to null)
zone =  # Zone | 

try:
    api_response = api_instance.update_zone(zoneId, zone)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ZoneApi->updateZone: %s\n" % e)
extern crate ZoneApi;

pub fn main() {
    let zoneId = zoneId_example; // String
    let zone = ; // Zone

    let mut context = ZoneApi::Context::default();
    let result = client.updateZone(zoneId, zone, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
zoneId*
String
The ID of the availability zone.
Required
Body parameters
Name Description
zone *

Zone payload.

Responses